VSCode FileHeader

Size

This is a header extension that contains multiple languages.

Feel good friends please give a star ~

Usage cookiecutter-vscode create project.
Custom fileheader Extension template

Install

1. ctrl + shift + x
2. Search VSCodeFileHeader

1. ctrl + p
2. ext install jankincai.vscodefileheader

Features

Support for automatic update time and author
Support for custom template(header/body)
Support for multiple languages
Support for suffix name mapping templates
Support for ignore suffix
Support for manual and automatic insert comment
Support vscode variables
Support remote synchronization(install git)

Example

example

More examples

Language

ActionScript
AppleScript
ASP
Batch
C
C#
C++
Clojire
CSS
D
Dart
Erlang
Go
Haskell
HTML
Java
JavaScript
LaTeX
Lisp
Lua
Matlab
Objective-C
OCaml
Pascal
Perl
PHP
Python
R
Ruby
Scala
SCSS
ShellScript
SQL
TypeScript
Vue
XML
YAML

Usage

# Settings
{
    "fileheader.author": "JanKinCai",
}

# Save file or ``ctrl + alt + i`` insert comment

Extension Settings

{
    # Set author
    "fileheader.author": "Your name",

    # Set insert body switch, default false
    "fileheader.body": true,

    # Set open file to insert header comment, default false
    "fileheader.open": true,

    # Set save file to insert header comment, default true
    "fileheader.save": true,

    # find max line of header comment, default 10
    "fileheader.header_max_line": 10,

    # Set datetime format, default YYYY-MM-DD HH:mm:ss
    # moment.js
    "fileheader.dateformat": "YYYY-MM-DD HH:mm:ss",

    # Set template mapping
    "fileheader.file_suffix_mapping": {
        ".pyx": "Python",
        "jkc-*.h": "H"
    },

    "fileheader.ignore": [
        "*.txt",             # Ignore suffix name
        "test.py",           # Ignore file
        "test"               # Ignore dir
    ]
}

Custom template(Add Email)

Note: The template header connot be modified and can be added.

Custom Header template template/header/Python.tmpl:

# @Author: {{author}}
# @Date:   {{create_time}}
# @Email:  {{email}}
# @Last Modified by:   {{last_modified_by}}
# @Last Modified time: {{last_modified_time}}

Custom Body template template/body/Python.tmpl:



def main():
    print("Hello, World!")


if __name__ == "__main__":
    main()

Settings:

{
    # Set template path
    "fileheader.custom_template_path": "xxx/template/",
    # Set other config
    "fileheader.other_config": {
        "email": "Your email",
    }
    # Set suffix mapping
    "fileheader.file_suffix_mapping": {
        ".py": "Python"
    },
}

Custom fileheader Extension template

fully modify template (example)

Custom Header template template/header/JKC.tmpl:

# @Name: {{name}}
# @Time: {{last_modified_time}}
# @Last Modified Author: {{name}}
# @Last Modified Time: {{last_modified_time}}

Custom Header template template/body/JKC.tmpl:

settings:

{
    "fileheader.is_header_exists": "@Name:",
    "fileheader.update_last_modified_time_flags": "@Last Modified Time:"
    "fileheader.update_last_modified_author_flags": "@Last Modified Author:"
    "fileheader.other_config": {
        "name": "jankincai",
    },
    "fileheader.file_suffix_mapping": {
        ".jkc": "JKC"
    },   
}

vscode variables

https://code.visualstudio.com/docs/editor/variables-reference

Custom Header template template/header/Python.tmpl:

# @Author: {{author}}
# @Date:   {{create_time}}
# @Last Modified by:   {{last_modified_by}}
# @Last Modified time: {{last_modified_time}}
# {{workspaceFolder}}
# {{workspaceFolderBasename}}
# {{file}}
# {{relativeFile}}
# {{relativeFileDirname}}
# {{fileBasename}}
# {{fileBasenameNoExtension}}
# {{fileDirname}}
# {{fileExtname}}
# {{cwd}}

Sync remote template

{
    # Set template path
    "fileheader.custom_template_path": "xxx/template/",

    # set ssh, https://jdblischak.github.io/2014-09-18-chicago/novice/git/05-sshkeys.html
    # "fileheader.remote": "git@github.com:caizhengxin/vscodefileheader.git"

    "fileheader.remote": "https://github.com/caizhengxin/fileheader-template.git"
}

Developer

$ git clone https://github.com/caizhengxin/vscodefileheader.git
$ code vscodefileheader
$ f5 # Enter Developer or Debug mode

PUblish package

# node_modules cannot be ignored by .vscodeignore.
$ sudo npm i vsce -g
$ vsce login jankincai
$ vsce package
$ vsce publish