Extract a banner comment from a string of javascript.

Usage no npm install needed!

<script type="module">
  import extractBanner from 'https://cdn.skypack.dev/extract-banner';


extract-banner NPM version Build Status

Extract a banner comment from a string of javascript.


Install with npm:

$ npm install extract-banner --save


Works for block and line comments.

var extract = require('extract-banner');

Heads up!: banner comments may be preceded by only whitespace and/or "use strict"; statements. Aside from those exceptions a banner comment must be the first thing in a string.


var fs = require('fs');
var extract = require('extract-banner');
var str = fs.readFileSync('fixtures/banner.js', 'utf8');
var banner = extract(str);

Results in:

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

Related projects


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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test


Jon Schlinkert


Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on March 20, 2016.