write-banner

write-banner

Add a banner to any file.

• Banner templates are just Lo-Dash/Underscore templates. Anything that works with those libs will work in banner templates.
• package.json is used for context
• the options object can be used to extend the context (package.json) passed to templates

Install with npm

$ npm i write-banner --save

Usage

writeBanner(src, dest, options);

Params:

• src: {String} the file to update
• dest: {String} optionally define a destination file path
• options: {Object} options and context for the banner.
  • banner: banner.tmpl template is used if a filepath to a custom template is not defined.
  • Your project's package.json is automatically passed to the templates as context. Define any additional fields you need on directly on the options and they will also be passed as context.

Examples:

var writeBanner = require('./');
writeBanner('a.js', 'b.js');

Results in b.js with:

/*!
 * banner-cli <https://github.com/jonschlinkert/banner-cli>
 *
 * Copyright (c) 2014 Jon Schlinkert, contributors.
 * Licensed under the MIT license.
 */

var yourCode = function() {};

Or pass additional context:

writeBanner('index.js', {
  banner: 'my-banner-template.tmpl',
  username: 'jonschlinkert',
  year: 2014,
  license: 'MIT'
});

Related projects

• add-banner: Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one… more
• strip-banner: Strip banners from code.

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on July 24, 2015.