Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including add-banner with all npm packages installed. Try it out:

var addBanner = require("add-banner")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

add-banner v1.0.0

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.

add-banner NPM version NPM monthly downloads NPM total downloads Linux Build Status

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 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.


Example usage

Pass a file path to the main export:

const banner = require('add-banner');

Results in the string:

 * banner-cli <>
 * Copyright (c) 2014-present Jon Schlinkert.
 * Licensed under the MIT license.

module.exports = () => {};


$ add-banner --help

  Usage: add-banner [options] <pattern>


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



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 is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the readme template.)

To generate the readme, run the following command:

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




Jon Schlinkert


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

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

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free