Topper is a file header utility. It will add a header to the file depending on the configurations made by you.
The gif below shows how to use the Topper extension.
This extension contributes the following settings:
-
topper.customTemplateParameters: This configures template parameters. These parameters can be used in the header templates as placeholders.The default setting is:
[ { "personalProfile": { "author": "bulbasaur", "website": "bulbasaur.github.bitbucket.yababbdadado.com", "copyright": "None", "license": "None", "email": "ivysaur.bulbasaur@venosaur.com" } }, { "officeProfile": { "author": "John Doe", "department": "Product Development", 94F5 "email": "john.doe@doejohn.com" } } ]
You can add any number of profiles to the list. You also have the ability to add in any number of parameters here in your profiles. This way you can use those parameters in the header templates.
-
topper.headerTemplates: This is the list of all the header templates you configure depending upon the languages being used.The list of language Ids can be found here: https://code.visualstudio.com/docs/languages/identifiers.
If the file's
languageIdis not configured here, it defaults to thedefaultCStyledheader template.Note: Please do not delete the
defaultCStyledtemplate. Copy it over when configuring this section.Note: Please keep the
defaultCStyledas the first element in the list of all the header templates.The default configuration for the header templates is:
[ { "defaultCStyled": { "headerBegin": "/**", "headerPrefix": "*", "headerEnd": "*/", "template": [ "${headerBegin}", "${headerPrefix} ${fileName}", "${headerPrefix} @author ${author}", "${headerPrefix} @description ${description}", "${headerPrefix} @created ${createdDate}", "${headerPrefix} @last-modified ${lastModifiedDate}", "${headerEnd}" ] } }, { "python": { "headerBegin": "#", "headerPrefix": "#", "headerEnd": "#", "template": [ "${headerBegin}", "${headerPrefix} ${fileName}", "${headerPrefix} @author ${author}", "${headerPrefix} @description ${description}", "${headerPrefix} @created ${createdDate}", "${headerPrefix} @last-modified ${lastModifiedDate}", "${headerEnd}" ] } } ]
As you can already see, each header template object is of form:
{ "<languageId>": { "headerBegin": <string value>, "headerPrefix": <string value>, "headerEnd": <string value>, "template": [ <string values with parameters> ] } }To use the parameters inside the
template, use the${<parameter name>}notation.
Topper has a few intrinsic template parameters:
-
createdDate- The date when the file was created, this is obtained from the underlying OS. If the file isUntitled-xor unsaved, the created time defaults to the timeTopper: Add Headercommand was invoked. -
lastModifiedDate- The date when the file was modified, this too is obtained from the underlying OS. If the file isUntitled-xor unsaved, the created time defaults to the timeTopper: Add Headercommand was invoked. -
fileName- The name of the file -
fileVersion- The VSCode maintained fileVersion
-
- Added support for multi line strings as values for the custom template parameters.
- Updated
lastModifiedDateto be fetched from the underlying OS. This is the true last modified date.
-
Initial release of
Topperextension. [Alpha]
In case of any suggestions or issues please email me at sidharth.mishra@sjsu.edu
- Template style configuration idea inspired by https://github.com/doi/fileheadercomment