bannerman

bannerman

Quick and dirty CLI util to add banner info to file(s) based on your package.json

Table of Contents

• Install
• Usage
• Contribute
• License

Install

This project uses node and npm.

$ npm install bannerman
$ # OR
$ yarn add bannerman

Usage

You should be in the root directory of the project (Same as the package.json file). Just list the files you would like to add banners to followed by --[name of property] for all the properties of your package.json you would like to add a banner. If you flag a property that doesn't exist it will just be ignored.

For example:

$ bannerman file1.js file2.css --name --version

Will generate at the top of file1.js and file2.css:

/**
 *
 * @name awesome-project
 * @version 1.0.0
 */

It can easily be used as a npm script:

"script": {
  "banner": "bannerman dist/awesome.js --name --version --author --license"
}

Note: - There is no support for nested properties in the package.json

Contribute

• Fork it and create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

License

MIT