extract-banner
Advanced tools
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.
Example
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.
*/
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
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.
FAQs
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.