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
- Usage
- Configure
- Future implementations
- Changelog
- How to contribute?
- Contributors
- 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.
Global scope
- Go to
Preferences > Settings
- Search by extension name in search bar
- 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
- Install tools for development
npm install -g yo generator-code vsce
- Install dependencies
npm install
Future implementations
Feel free to propose new ideas by opening new issues ! :rocket:
- [x] Customized settings per project (v1.0.10)
Changelog
SEE CHANGELOG IN CHANGELOG.md.
How to contribute?
Contributions are most welcome! :smile:
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Added some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
Contributors
License
See license.txt.
