update-banner

update-banner

Update the banner comment in a string of javascript.

Install

Install with npm:

$ npm install --save update-banner

Usage

In existing banners, copyright statements are updated using update-copyright. If the string does not have a banner one will be added using a template.

var banner = require('update-banner');
var str = fs.readFileSync('index.js', 'utf8');
banner(str);

Pass a custom template and/or data:

var copyright = 'Copyright (c) 2015, Jon Schlinkert.';

console.log(banner('/* <%= copyright %> */\n', {
  copyright: copyright 
}));
//=> '/* Copyright (c) 2015, Jon Schlinkert. */\n'

Options

options.template

Customize the template to use for creating a banner.

Example

This is the default template

/*!
 * <%= name %> <<%= repository %>>
 *
 * <%= copyright %>
 * Released under the <%= license %> License.
 */

About

Related projects

• extract-banner: Extract a banner comment from a string of javascript. | homepage
• strip-banner: Strip banners from code. | homepage
• update-copyright: Update a copyright statement with the current year. Also makes minor corrections. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

This file was generated by verb-generate-readme, v0.4.2, on February 01, 2017.