has-banner

has-banner

Returns true if a file has a banner code comment. Used for linting.

Install

Install with npm:

$ npm install has-banner --save

Usage

var hasBanner = require('has-banner');

hasBanner('/*! Copyright whatever */');
//=> 'true'

hasBanner('a/*! Copyright whatever */');
//=> 'false'

Pass an array of keywords to disqualify banners (jshint and global are already included)

hasBanner('/*! jshint:foo */');
//=> false

hasBanner('/*! foo */', ['foo']);
//=> false

Related projects

• add-banner: Add a banner to a string. Banners are just Lo-Dash/underscore templates, if a custom one… more | 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

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

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