Extract a banner comment from a string of javascript.
npm install extract-banner> Extract a banner comment from a string of javascript.
Install with npm:
``sh`
$ npm install extract-banner --save
Works for block and line comments.
`js`
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.
Example
`js`
var fs = require('fs');
var extract = require('extract-banner');
var str = fs.readFileSync('fixtures/banner.js', 'utf8');
var banner = extract(str);
Results in:
`js`
/**
* extract-banner
*
* Copyright (c) 2016, Jon Schlinkert.
* Licensed under the MIT license.
*/
* add-banner: Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one… more | homepage
* has-banner: Returns true if a file has a banner code comment. Used for linting. | homepage
* strip-banner: Strip banners from code. | homepage
* update-banner: Add or update a banner in a string. | homepage
* write-banner: Add a banner to any file. | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
`sh`
$ npm install verb && npm run docs
Or, if verb is installed globally:
`sh`
$ verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2016 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb, v0.9.0, on March 20, 2016._