Skip to content

cesumilo/vs-auto-header

 
 

Repository files navigation

VS Auto Header

Version: v1.1.0

Description

This extension inserts an header in a new file or an existing file.

Supported languages

  • JavaScript
  • C++
  • C
  • C#
  • CSS
  • Go
  • Groovy
  • Java
  • Less
  • Objectiv C
  • Objectiv C++
  • Razor
  • SCSS
  • SQL
  • Swift
  • TypeScript
  • Makefile
  • Dockerfile
  • CoffeeScript
  • Yaml
  • HTML
  • Jade
  • XML
  • Python
  • TypeScript React
  • Dart
  • Bat
  • Powershell

Table of contents

  1. Usage
  2. Configure
  3. Future implementations
  4. Changelog
  5. How to contribute?
  6. Contributors
  7. License

Usage

When a new file is created and has code inside, VS Code will be able to detect which langage you are using and the extension will display a confirmation box (see below) to insert an header. In addition, if you open a file with code inside but which has no header, the extension will detect it and ask you if you want to insert one.

Configure

Global scope

  1. Go to Preferences > Settings

  1. Search by extension name in search bar

  1. Modify extension settings

Project scope

You can also override global configuration using a file .vsconfig at the root directory of your project. It has to respect JSON format and implement the following variables:

{
  "fileheader": {
    "Author": "Guillaume Robin",
    "Email": "my-email@gmail.com",
    "Copyrights": "GPL-3.0"
  }
}

Example

/**
 * @author Guillaume Robin <my-email@gmail.com>
 * @file Description
 * @desc Created on 2019-08-28 12:18:44 pm
 * @copyright GPL-3.0
 */

Getting started

Requirements

  1. Install tools for development
npm install -g yo generator-code vsce
  1. Install dependencies
npm install

Future implementations

Feel free to propose new ideas by opening new issues ! 🚀

  • Customized settings per project (v1.0.10)

Changelog

SEE CHANGELOG IN CHANGELOG.md.

How to contribute?

Contributions are most welcome! 😄

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributors

License

See license.txt.

About

Visual Studio Code extension for file header

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%