HeaderWizard

HeaderWizard

Visual Studio Code Extension

Report Bug · Request Feature · Changelog

About the project

HeaderWizard extension for Visual Studio Code enhances your coding experience by allowing you to effortlessly add custom headers to specified file types. With this extension, you can define templates for headers tailored to different file extensions, ensuring consistency and compliance with project standards.

Key Features:

• Custom Templates: Define unique header templates for various file types, such as .lua, .cpp, .java, etc.
• Automatic Header Insertion: When creating a new file with a supported extension, the extension automatically adds the predefined header template.
• Flexibility: Modify and update templates easily to adapt to changing project requirements or coding standards.
• Save Time and Maintain Consistency: Streamline your workflow by eliminating the need to manually add headers to each file, while ensuring uniformity across your codebase.
• Simple Interface: Simple configuration interface within VS Code makes setting up and managing templates a breeze.
• Extensibility: Support for adding new file types and customizing templates as per your needs.

Get the HeaderWizard extension for VS Code now and level up your coding efficiency and consistency!

back to top

Getting started

Create your first template

Prerequisites

Visual Studio Code (1.87.0 or newer)

If you want to install the development version you need to have node and npm installed on your system to run it. It is recommended to use the node version used for VS Code development itself which is documented here

Installation

To install the development version:

1. git clone https://github.com/4c65736975/headerWizard
2. code headerWizard
3. npm install in the terminal, then F5 to run

To install the latest stable development version:

1. Download the latest release
2. Open the VS Code Extensions tab Ctrl+Shift+X
3. Click ··· in upper right corner of the tab
4. Click Install from VSIX... and select the downloaded .vsix file

To install the latest stable version:

1. Install it like any other extension via VS Code Marketplace, you can follow the official docs

back to top

Usage

Make sure that the template you want to use is currently enabled

When creating a new file, the template that is currently enabled for a given extension is automatically applied

Parameters

Customize your header templates effortlessly using dynamic parameters enclosed in curly braces {}. Available parameters include:

Filename
Inserts the created file name with its extension.
{filename} e.g. main.ts

Date
Inserts the current day.
{DD} e.g. 28

Inserts the current month.
{MM} e.g. 04

Inserts the current short year.
{YY} e.g. 24

Inserts the current long year.
{YYYY} e.g. 2024

Combine these parameters to create your desired date format. For instance, {DD.MM.YY} or {MM/DD/YYYY}. The possibilities are endless!

back to top

License

Distributed under the GPL-3.0 license. See LICENSE for more information.

back to top

Acknowledgments

• Choose an Open Source License
• Best README Template

back to top