strip-banner/README.md

Strip banners from code.

# strip-banner [![NPM version](https://img.shields.io/npm/v/strip-banner.svg)](https://www.npmjs.com/package/strip-banner) [![Build Status](https://img.shields.io/travis/jonschlinkert/strip-banner.svg)](https://travis-ci.org/jonschlinkert/strip-banner)

> Strip banners from code.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install strip-banner --save
```

## Usage

```js
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:

```js
// --foo.js--

/**
 * strip-banner <https://github.com/jonschlinkert/strip-banner>
 *
 * Copyright (c) 2016, Jon Schlinkert.
 * Licensed under the MIT license.
 */
function foo () {}
```

```js
var fs = require('fs');
var strip = require('strip-banner');
var str = fs.readFileSync('foo.js', 'utf8');
console.log(strip(str));
```

Results in:

```js
function foo () {}
```

## Related projects

* [add-banner](https://www.npmjs.com/package/add-banner): Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one… [more](https://www.npmjs.com/package/add-banner) | [homepage](https://github.com/jonschlinkert/add-banner)
* [extract-banner](https://www.npmjs.com/package/extract-banner): Extract the banner from a string of javascript. | [homepage](https://github.com/jonschlinkert/extract-banner)
* [has-banner](https://www.npmjs.com/package/has-banner): Returns true if a file has a banner code comment. Used for linting. | [homepage](https://github.com/jonschlinkert/has-banner)
* [update-banner](https://www.npmjs.com/package/update-banner): Add or update a banner in a string. | [homepage](https://github.com/jonschlinkert/update-banner)
* [write-banner](https://www.npmjs.com/package/write-banner): Add a banner to any file. | [homepage](https://github.com/jonschlinkert/write-banner)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/strip-banner/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License

Copyright © 2016 [Jon Schlinkert](https://github.com/jonschlinkert)
Released under the MIT license.

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on March 20, 2016._