strip-banner
v0.2.0
Published
Strip banners from code.
Downloads
1,121
Maintainers
Readme
strip-banner
Strip banners from code.
Install
Install with npm:
$ npm install strip-banner --save
Usage
var strip = require('strip-banner');
strip(str);
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 for it to be stripped.
Example
Given the following:
// --foo.js--
/**
* strip-banner <https://github.com/jonschlinkert/strip-banner>
*
* Copyright (c) 2016, Jon Schlinkert.
* Licensed under the MIT license.
*/
function foo () {}
var fs = require('fs');
var strip = require('strip-banner');
var str = fs.readFileSync('foo.js', 'utf8');
console.log(strip(str));
Results in:
function foo () {}
Related projects
- add-banner: Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one… more | homepage
- extract-banner: Extract the banner from a string of javascript. | homepage
- has-banner: Returns true if a file has a banner code comment. Used for linting. | homepage
- update-banner: Add or update a banner in a string. | homepage
- write-banner: Add a banner to any file. | homepage
Contributing
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
Author
Jon Schlinkert
License
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on March 20, 2016.