A CLI tool for generating file header from a configuration file and an EJS template.
npm i -g file-header
Data to be presented on a file header is stored in a config file which is located at ~/.file-headers/template_data.js
The default content of this file will be as follows.
module.exports = {
user: process.env.USER,
email: process.env.USER '@' process.env.HOST,
date: new Date(),
};We can customize it as required. For example, change it to
module.exports = {
user: 'Jake sully'
email: '[email protected]'
github: 'https://github.com/jakesully'
date: new Date(),
};Edit the EJS tempalte of the default file-header ( Optional )
The default file header template can be found at ~/.file-headers/default
It is just EJS template. We can customize it to any extend.
If we require different template for each file type , create a file ~/.file-headers/<extention>
- For javscript, create a custom template at
~/.file-headers/jsand customize it. - If we want a custom header for '*.spec.js' file, create ~/.file-headers/spec.js and customize it
Commandline
file-header <filename.ext>
which will print the file header to your console.
Add the below line to your vim config file
command! Header :execute '0r!file-header %'Now, type :Header to add file header to your current buffer.