add-banner

add-banner

Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one isn't defined a default will be used.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save add-banner

Context and templates

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

API

Example usage

Pass a file path to the main export:

const banner = require('add-banner');
console.log(banner('./index.js'));

Results in the string:

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

module.exports = () => {};

CLI

$ add-banner --help

  Usage: add-banner [options] <pattern>

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -t, --template [filepath]  path to template file

About

Contributing

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

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

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

Contributors

Commits	Contributor
13	ain
6	jonschlinkert
1	pmentz
1	cyxou

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on June 27, 2018.