{"id":21293924,"url":"https://github.com/bankkroll/auto-header-est2023","last_synced_at":"2026-05-19T11:06:57.707Z","repository":{"id":193561923,"uuid":"688989667","full_name":"BankkRoll/auto-header-est2023","owner":"BankkRoll","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-16T15:30:43.000Z","size":96,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T06:47:52.506Z","etag":null,"topics":["code-comments","vscode","vscode-extension","vscode-settings"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=Bankkroll.auto-header-est2023","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BankkRoll.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":"2023-09-08T14:34:04.000Z","updated_at":"2024-05-16T15:30:47.000Z","dependencies_parsed_at":"2024-05-16T16:42:25.541Z","dependency_job_id":"e3fb7644-86f5-450f-ada2-912c1a7ed4a7","html_url":"https://github.com/BankkRoll/auto-header-est2023","commit_stats":null,"previous_names":["bankkroll/auto-header-est2023"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BankkRoll%2Fauto-header-est2023","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BankkRoll%2Fauto-header-est2023/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BankkRoll%2Fauto-header-est2023/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BankkRoll%2Fauto-header-est2023/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BankkRoll","download_url":"https://codeload.github.com/BankkRoll/auto-header-est2023/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243762269,"owners_count":20343979,"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":["code-comments","vscode","vscode-extension","vscode-settings"],"created_at":"2024-11-21T13:57:03.995Z","updated_at":"2026-05-19T11:06:57.676Z","avatar_url":"https://github.com/BankkRoll.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1 align=\"center\"\u003e\n\u003cimg src=\"https://github.com/BankkRoll/auto-header-est2023/assets/106103625/d5ccd12d-336f-4574-a2a6-2c012ddeea9c\" /\u003e\n\u003cbr\u003eauto-header-est2023\n\u003c/h1\u003e\n\u003ch3\u003e◦ Enhance your coding experience in Visual Studio Code with the \"Header Naming\" extension. Seamlessly name your files with custom headers tailored to your preferences. Choose between concise single-line comments or comprehensive multi-line block comments. Use the built-in command, opt for the auto-tagging feature, or simply enable auto-tag, and we'll discern the language and automatically insert appropriate headers for every new file you create.\u003c/h3\u003e\n\u003c/div\u003e\n\n\u003ch4\u003eOur extension boasts compatibility with an extensive array of programming languages, including but not limited to:\u003c/h4\u003e\n\u003cul\u003e\n    \u003cli\u003eJavaScript\u003c/li\u003e\n    \u003cli\u003ePython\u003c/li\u003e\n    \u003cli\u003eJava\u003c/li\u003e\n    \u003cli\u003eC/C++/C#\u003c/li\u003e\n    \u003cli\u003eRuby\u003c/li\u003e\n    \u003cli\u003ePHP\u003c/li\u003e\n    \u003cli\u003e... and dozens more!\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003eFor a comprehensive list of supported languages and their respective comment syntax, delve into the \u003ca href=\"src/extension.ts\"\u003esource code\u003c/a\u003e.\u003c/p\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg?style\" alt=\"License\" /\u003e \u003cimg src=\"https://img.shields.io/badge/JavaScript-JavaScript-F7DF1E?style\u0026logo=JavaScript\u0026logoColor=F7DF1E\" alt=\"JavaScript\" /\u003e \u003cimg src=\"https://img.shields.io/badge/TypeScript-TypeScript-3178C6?style\u0026logo=TypeScript\u0026logoColor=3178C6\" alt=\"TypeScript\" /\u003e \u003cimg src=\"https://img.shields.io/github/stars/BankkRoll/auto-header-est2023.svg?style=social\" alt=\"GitHub Stars\" /\u003e \u003cimg src=\"https://img.shields.io/github/last-commit/BankkRoll/auto-header-est2023.svg?style\" alt=\"GitHub Last Commit\" /\u003e \u003cimg src=\"https://img.shields.io/github/repo-size/BankkRoll/auto-header-est2023.svg?style\" alt=\"GitHub Repo Size\" /\u003e \u003c/div\u003e\n\n\u003c/div\u003e\n\n---\n\n## 🗂️ Table of Contents\n\n- [Features](#️-features)\n- [Installation](#-installation)\n- [Usage](#-usage)\n- [Scripts](#-scripts)\n- [Configuration](#-configuration)\n- [Directory Tree](#-directory-tree)\n- [Language Usage](#-language-usage)\n- [Contributing](#-contributing)\n- [License](#-license)\n- [Author](#-author)\n\n---\n\n## ⚙️ Features\n\n| Feature | Description |\n| ------- | ----------- |\n| **Multiple Language Support** | Supports over **100 programming languages** and counting! The extension automatically detects the language's comment syntax for precise header insertion. |\n| **Auto Header Insertion (Beta)** | Automatically inserts headers into new files of supported languages. |\n| **File Path Comment** | Automatically generates and inserts the file's relative path as a comment. |\n| **Custom Comment Syntax** | Define custom comment syntax for specific languages that may not be covered by default. |\n| **Customization** | Personalize your headers with dynamic placeholders such as:\u003cbr\u003e - `{author}`: Designate the file's author.\u003cbr\u003e - `{date}`: Timestamp your work with the creation or last modified date.\u003cbr\u003e - `{company}`: Attribute the work to a particular organization or entity.\u003cbr\u003e - `{license}`: Specify the license type.\u003cbr\u003e - `{githubLink}`: Include a link to your GitHub repository.\u003cbr\u003e - `{filePath}`: Include the file's relative path.\u003cbr\u003e - `{line1}`: Custom header line 1.\u003cbr\u003e - `{line2}`: Custom header line 2.\u003cbr\u003e - `{line3}`: Custom header line 3. |\n| **Header Layout** | Customize the order and layout of the header sections. |\n| **Ignored Paths** | Specify file paths or directories to ignore when adding headers. |\n\n---\n\n## 📦 Installation\n\n1. Launch Visual Studio Code.\n2. Navigate to Extensions or press `Ctrl+Shift+X`.\n3. In the search bar, type \"Auto Header EST.2023\" and select the corresponding result to install.\n\n---\n\n## 🚀 Usage\n\n### Auto-Tagging Configuration\n\n1. **Enable Auto Header:**\n   - Navigate to your VS Code settings.\n   - Enable `auto-header-est2023.autoHeader` to automatically append headers to new files of supported languages.\n   - Enable `auto-header-est2023.autoGenerateFilePath` to automatically generate and insert the relative path of the file.\n\n2. **Customize Your Header:**\n   - Configure the following settings in your VS Code settings:\n     - `auto-header-est2023.author`: Set the author's name.\n     - `auto-header-est2023.date`: Set the date format (use `{timestamp}` for the current date).\n     - `auto-header-est2023.company`: Set the company's name.\n     - `auto-header-est2023.license`: Choose the license type from predefined options (e.g., MIT, GPL-3.0).\n     - `auto-header-est2023.githubLink`: Set the GitHub repository link.\n     - `auto-header-est2023.line1`, `auto-header-est2023.line2`, `auto-header-est2023.line3`: Customize additional header lines.\n\n3. **Comment Style:**\n   - Set the preferred comment style:\n     - `auto-header-est2023.commentType`: Choose between `singleline` and `multiline`.\n\n4. **Custom Comment Syntax:**\n   - Define custom comment syntax for specific languages:\n     - `auto-header-est2023.customCommentSyntax`: Example: `{\"mylang\": {\"single\": \"##\", \"multiStart\": \"/**\", \"multiEnd\": \"**/\"}}`.\n\n5. **Ignored Paths:**\n   - Specify file paths or directories to ignore when adding headers:\n     - `auto-header-est2023.ignoredPaths`: Example: `[\".next\", \"node_modules\"]`.\n\n6. **Custom Header Template:**\n   - Use a custom header template:\n     - `auto-header-est2023.customHeaderTemplate`: Example: `{single} {author}\\n{single} {date}\\n{single} {company}\\n{single} {license}\\n{single} {githubLink}\\n{single} {line1}\\n{single} {line2}\\n{single} {line3}\\n`.\n\n7. **Header Layout:**\n   - Customize the order and layout of the header sections:\n     - `auto-header-est2023.headerLayout`: Example: `[\"author\", \"date\", \"company\", \"license\", \"githubLink\"]`.\n\n### Quick Header Generation\n\n- Use the `Ctrl+Shift+SpaceBar` shortcut for immediate header generation.\n\n### Command Palette\n\n- Activate the command palette with `Ctrl+Shift+P`.\n- Search for and select \"Add Header\".\n\n---\n\n## 🔧 Configuration Options\n\nHere are all the available settings you can configure for the Auto Header EST.2023 extension:\n\n| Setting | Type | Default | Description |\n| ------- | ---- | ------- | ----------- |\n| `auto-header-est2023.enabled` | boolean | `true` | Enable or disable the Auto Header extension. |\n| `auto-header-est2023.autoHeader` | boolean | `false` | Automatically insert headers into new files of supported languages. |\n| `auto-header-est2023.autoGenerateFilePath` | boolean | `false` | Automatically generate and insert the file's relative path as a comment. |\n| `auto-header-est2023.commentType` | string | `multiline` | Preferred comment style (`singleline` or `multiline`). |\n| `auto-header-est2023.author` | string | `\"\"` | Author's name. Replaces the `{author}` placeholder. |\n| `auto-header-est2023.company` | string | `\"\"` | Company's name. Replaces the `{company}` placeholder. |\n| `auto-header-est2023.date` | string | `{timestamp}` | Set to `timestamp` for the current date. Replaces the `{date}` placeholder. |\n| `auto-header-est2023.line1` | string | `Author: {author}` | First header line. Placeholders: `{author}`, `{date}`, `{company}`. Leave blank to skip. |\n| `auto-header-est2023.line2` | string | `Created: {date}` | Second header line. Placeholders: `{author}`, `{date}`, `{company}`. Leave blank to skip. |\n| `auto-header-est2023.line3` | string | `(c) Copyright by {company}` | Third header line. Placeholders: `{author}`, `{date}`, `{company}`. Leave blank to skip. |\n| `auto-header-est2023.customCommentSyntax` | object | `{}` | Custom comment syntax for specific languages. Example: `{\"mylang\": {\"single\": \"##\", \"multiStart\": \"/**\", \"multiEnd\": \"**/\"}}`. |\n| `auto-header-est2023.ignoredPaths` | array | `[\".next\", \"node_modules\"]` | List of file paths or directories to ignore when adding headers. Example: `[\".next\", \"node_modules\"]`. |\n| `auto-header-est2023.license` | string | `MIT` | Select the license for the file. Options: `MIT`, `GPL-3.0`, `Apache-2.0`, `BSD-2-Clause`, `BSD-3-Clause`, `ISC`, `MPL-2.0`, `LGPL-3.0`, `Unlicense`, `EPL-2.0`. |\n| `auto-header-est2023.githubLink` | string | `\"\"` | GitHub repository link. |\n| `auto-header-est2023.customHeaderTemplate` | string | `{single} {author}\\n{single} {date}\\n{single} {company}\\n{single} {license}\\n{single} {githubLink}\\n{single} {line1}\\n{single} {line2}\\n{single} {line3}\\n` | Template for the custom header. Use placeholders: `{single}`, `{multiStart}`, `{multiEnd}`, `{author}`, `{date}`, `{company}`, `{license}`, `{githubLink}`, `{line1}`, `{line2}`, `{line3}`. |\n| `auto-header-est2023.headerLayout` | array | `[\"author\", \"date\", \"company\", \"license\", \"githubLink\"]` | Customize the order and layout of the header sections. Example: `[\"author\", \"date\", \"company\", \"license\", \"githubLink\"]`. |\n\n---\n\n## 🤝 Contributing\n\n1. Fork the Project\n2. Create your Feature Branch\n3. Commit your Changes\n4. Push to the Branch\n5. Open a Pull Request\n6. Code review\n7. Merge the changes\n8. Update the documentation\n\n---\n\n## 📝 License\n\nThis project is licensed under [MIT](./LICENSE).\n\n## 👤 Author\n\n**[BankkRoll](https://github.com/BankkRoll)**\n\n- Twitter: [@bankkroll_eth](https://twitter.com/bankkroll_eth)\n- GitHub: [@BankkRoll](https://github.com/BankkRoll)\n\n\n---\n\n\u003cp align=\"center\"\u003e\u003ci\u003e\u003cfont color=\"grey\"\u003eThis README.md has been generated with ❤️ using \u003ca href=\"https://github.com/BankkRoll/quick-readme\"\u003equick-readme\u003c/a\u003e\u003c/font\u003e\u003c/i\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbankkroll%2Fauto-header-est2023","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbankkroll%2Fauto-header-est2023","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbankkroll%2Fauto-header-est2023/lists"}