auto-header-est2023
◦ 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.
Our extension boasts compatibility with an extensive array of programming languages, including but not limited to:
- JavaScript
- Python
- Java
- C/C++/C#
- Ruby
- PHP
- ... and dozens more!
For a comprehensive list of supported languages and their respective comment syntax, delve into the source code.
🗂️ Table of Contents
⚙️ Features
Feature |
Description |
Multiple Language Support |
Supports over 100 programming languages and counting! The extension automatically detects the language's comment syntax for precise header insertion. |
Auto Header Insertion (Beta) |
Allows for headers to be automatically inserted into new files of recognized languages. |
File Naming Feature |
Directly place headers in files or entire folders, ensuring a consistent and organized codebase. |
Extendable |
For those niche languages or specific use cases, easily define custom comment syntax that may not be covered by default. |
Customization |
Personalize your headers with dynamic placeholders such as: - {author} : Designate the file's author. - {date} : Timestamp your work with the creation or last modified date. - {company} : Attribute the work to a particular organization or entity. |
📦 Installation
- Launch Visual Studio Code.
- Navigate to Extensions or press
Ctrl+Shift+X
.
- In the search bar, type "Header Naming" and select the corresponding result to install.
🚀 Usage
To seamlessly insert headers into your code, follow the steps below:
Auto-Tagging Configuration:
- Navigate to your VSCode settings.
- Enable
auto-header-est2023.autoHeader
.
- This sets the extension to automatically append headers to new files of supported languages.
Quick Header Generation:
- Use the
Ctrl+Shift+SpaceBar
shortcut for immediate header generation.
Command Palette:
- Activate the command palette with
Ctrl+Shift+P
.
- Search for and select "Add Header".
🛠️ Scripts
Here are some common scripts you can run:
vscode:prepublish
Prepares the extension for publishing.
You can run this script using npm or yarn:
npm run vscode:prepublish
Or with yarn:
yarn vscode:prepublish
compile
Uses webpack to compile the TypeScript source code.
You can run this script using npm or yarn:
npm run compile
Or with yarn:
yarn compile
watch
Uses webpack in watch mode to automatically recompile when files change.
You can run this script using npm or yarn:
npm run watch
Or with yarn:
yarn watch
package
Packages the extension in production mode.
You can run this script using npm or yarn:
npm run package
Or with yarn:
yarn package
Configuration
Harness the full potential of "Auto Header EST.2023" by tailoring it to your preferences using the VSCode settings:
auto-header-est2023.autoHeader
: Enable this option to automatically insert headers into new files of supported languages.
auto-header-est2023.autoGenerateFilePath
: If enabled, the extension will automatically generate and insert the relative path of the file as a comment, providing a clearer context within larger projects.
auto-header-est2023.commentType
: Choose your preferred comment style. Options include:
- "singleline": All header content is condensed into a single line.
- "multiline": The header content spans across multiple lines.
auto-header-est2023.author
: Specify the author's name which replaces the {author}
placeholder in the header.
auto-header-est2023.company
: Register your company's name, which will replace the {company}
placeholder.
auto-header-est2023.date
: By default, set to {timestamp}
which inputs the current timestamp. This replaces the {date}
placeholder in the header. If you wish to have a custom date format, this can be defined here.
auto-header-est2023.line1
, line2
, line3
: Fine-tune each line of the header with dynamic placeholders. Available placeholders include {author}
, {date}
, and {company}
. If you prefer to exclude any of these lines from the header, simply leave the corresponding setting blank.
auto-header-est2023.customCommentSyntax
: Define custom comment syntax for specific or niche languages that might not be covered by default. This allows you to extend the utility of the extension to virtually any language.
🌳 Directory Tree
├── 📄 .eslintrc.json
├── 📦 .vscode/
├── 📄 extensions.json
├── 📄 launch.json
├── 📄 settings.json
└── 📄 tasks.json
├── 📄 .vscodeignore
├── 📄 README.md
├── 📄 CHANGELOG.md
├── 📦 dist/
├── 📄 extension.js
└── 📄 extension.js.map
├── 📄 package-lock.json
├── 📄 package.json
├── 📦 src/
├── 📄 extension.ts
└── 📂 test/
├── 📄 runTest.ts
└── 📂 suite/
├── 📄 extension.test.ts
└── 📄 index.ts
├── 📄 tsconfig.json
├── 📄 vsc-extension-quickstart.md
└── 📄 webpack.config.js
💻 Language Usage
JSON: ██████ 52.42%
TypeScript: ██ 35%
Other: █ 11.58%
🤝 Contributing
- Fork the Project
- Create your Feature Branch
- Commit your Changes
- Push to the Branch
- Open a Pull Request
- Code review
- Merge the changes
- Update the documentation
📝 License
This project is licensed under MIT.
👤 Author
BankkRoll
This README.md has been generated with ❤️ using quick-readme