{"id":13340920,"url":"https://github.com/5P5/vscode-file-header","last_synced_at":"2025-03-11T19:30:58.759Z","repository":{"id":42887345,"uuid":"254935169","full_name":"5P5/vscode-file-header","owner":"5P5","description":"Automatically (or by command or shortcut) insert (and update) file header text (author comment). Easy configuration and powerful customization to fit any needs!","archived":false,"fork":false,"pushed_at":"2023-03-28T18:41:28.000Z","size":772,"stargazers_count":6,"open_issues_count":12,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-24T06:30:30.853Z","etag":null,"topics":["author","automated","automatic","comment","copyright","custom","customization","easy","easy-to-use","file-header","file-info","header","info","license","multi-root","multiroot","power","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=epivision.vscode-file-header","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/5P5.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-11T18:59:12.000Z","updated_at":"2021-12-19T15:05:46.000Z","dependencies_parsed_at":"2024-10-24T01:18:00.744Z","dependency_job_id":"397d0bb2-37d7-4847-8e3b-fb0f4d80dff2","html_url":"https://github.com/5P5/vscode-file-header","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5P5%2Fvscode-file-header","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5P5%2Fvscode-file-header/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5P5%2Fvscode-file-header/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/5P5%2Fvscode-file-header/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/5P5","download_url":"https://codeload.github.com/5P5/vscode-file-header/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243098680,"owners_count":20236070,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["author","automated","automatic","comment","copyright","custom","customization","easy","easy-to-use","file-header","file-info","header","info","license","multi-root","multiroot","power","vscode","vscode-extension"],"created_at":"2024-07-29T19:24:30.539Z","updated_at":"2025-03-11T19:30:58.435Z","avatar_url":"https://github.com/5P5.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e👊 Power Header 💥\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\u003cb\u003ePower Header\u003c/b\u003e automatically (or via command/shortcut \u003ckbd\u003eCtrl+Alt+H\u003c/kbd\u003e) inserts (and updates) file header text (author comment).\u003cbr/\u003e\n\u003cb\u003ePower Header\u003c/b\u003e offers easy configuration and powerful customization to fit any needs!\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=epivision.vscode-file-header\"\u003e\u003cimg src=\"https://badgen.net/vs-marketplace/v/epivision.vscode-file-header?icon=windows\" alt=\"vs-marketplace version\"\u003e\u003c/a\u003e\n\u003cimg src=\"https://badgen.net/vs-marketplace/i/epivision.vscode-file-header\" alt=\"vs-marketplace installs\"\u003e\n\u003cimg src=\"https://badgen.net/vs-marketplace/d/epivision.vscode-file-header\" alt=\"vs-marketplace downloads\"\u003e\n\u003cimg src=\"https://badgen.net/vs-marketplace/rating/epivision.vscode-file-header\" alt=\"vs-marketplace rating\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"demo.gif\" alt=\"short demo of Power Header in action\" width=\"800\"\u003e\u003c/p\u003e\n\n## Features\n\n\u003e The following are abridged descriptions. Please see in **Power Header** settings for all the juicy delicious details 🤤\n\n| What you ask for ❔ | What you get ❗ |\n|:-:|---|\n| 🗃️ Supported Languages | 💯% all of them! |\n| ⏩ Automatic Header Insert and Update | Sir, yes, sir!\u003cbr/\u003eAutomagically ✨ insert header into new files (🛑 black-/whitelist-support *of course*) and update on save.\u003cbr/\u003eNot a single keyboard shortcut pressed! |\n| 📄 Header Template | can be a **text string**, 😐\u003cbr/\u003eread from a **local file**, 😲\u003cbr/\u003eor even a **remote resource**! 🤯 (http(s)://)|\n| 🔀 Variables for Interpolation in Template | **Ain't no hard-coded fields BS here!**\u003cbr/\u003eYou can do whatever the f🤐 you want!\u003cbr/\u003eUse all [vscode snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables) and define custom variable pairs — they can even be JavaScript code, allowing for arbitrary complex text, date formats, etc.! 🎉 |\n| 💬 Comment Styles | ⬛ Block Comment style,\u003cbr/\u003e➖ Line Comment style,\u003cbr/\u003e📃 or Insert header as is (your very own style). |\n| 🔄 Header Content Update | Update the header via command/shortcut or automatically on file save.\u003cbr/\u003eJavaScript regular expression replace allows for arbitrary complex text updates. 🎉\u003cbr/\u003eUse with caution ⚠️ |\n| Wow, all this is awesome 😮, but I have that super rare special edge-case in my multi-root workspace for this file language 🥺\u003cbr/\u003e*— I hear you say* ⁉ | Harness the full **Power Header** and *VS Code* built-in power 💥\u003cbr/\u003eYou can always overwrite all **Power Header** settings in a (*Workspace* or *.vscode* folder) *settings.json*, even language specific: `\"[\u003clanguage\u003e]\": { \"powerHeader.\u003csetting\u003e\": ... }`, to achieve your desired header style 👍 |\n\n## Use Case Examples (extending default settings)\n\n1. Insert a simpler header in plain text files (via command/shortcut) ⚙️ *User settings.json*\n\t```json\n\t\"[plaintext]\": {\n\t\t\"powerHeader.commentMode\": \"raw\",\n\t\t\"powerHeader.template\": \"Author: \u003cauthor\u003e (email) / $TM_FILENAME @ !date!\"\n\t}\n\t```\n\tlet's make this work ⏩ automatically for plain text files only:\n\t```jsonc\n\t\"[plaintext]\": {\n\t\t\"powerHeader.autoInsert.enable\": true,\n\t\t\"powerHeader.autoInsert.allow\": \"always\",\n\t\t\"powerHeader.commentMode\": \"raw\",\n\t\t\"powerHeader.template\": \"Author: \u003cauthor\u003e (email) / $TM_FILENAME @ !date!\"\n\t}\n\t```\n\n1. Use another header for that client project ⚙️ *Workspace settings.json*\n\t```jsonc\n\t\"powerHeader.template\": \"file://$WORKSPACE_FOLDER/dev/template.txt\"\n\t```\n\t\n1. Your company requires you to use a specific header template in `cpp`? Easy! ⚙️ \\\u003cany\u003e\n\t```jsonc\n\t\"[cpp]\": { \n\t\t\"powerHeader.commentMode\": \"line\",\n\t\t\"powerHeader.template\": \"https://intranet.company.com/static/templates/cpp/header\",\n\t}\n\t```\n\n## Extension Settings\n\nSee *Feature Contributions* tab⤴️ and better check in *Settings*➡️*Extensions*➡️**Power Header** for detailed explanation.\n\n\u003e Unfortunately current *Feature Contributions* Description column does not support markdownDescription [🐞 issue here](https://github.com/microsoft/vscode/issues/88927)\n\n## Known Issues\n\n🐞 `\"powerHeader.update.enable\": \"save\"` will not work correctly in combination with `\"files.autoSave\": \"onFocusChange\"`  \n(The focus-losing document will be saved nonetheless, but *header content update* will be tried in the focus-gaining (editable) editor)  \n🩹 Workarounds:  \nIf you want to keep `\"files.autoSave\": \"onFocusChange\"` set `\"powerHeader.update.enable\": \"manual\"`  \nor use `\"powerHeader.update.enable\": \"save\"` with `\"files.autoSave\": \"off|afterDelay|onWindowChange\"` setting","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F5P5%2Fvscode-file-header","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F5P5%2Fvscode-file-header","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F5P5%2Fvscode-file-header/lists"}