epicoxymoron/strip-comments

Strip block comments or line comments from code. The tests remove comments from JavaScript, but this will work with any language that uses the same syntax for comments.

strip-comments

Strip comments from code. Removes line comments, block comments, the first comment only, or all comments. Optionally leave protected comments unharmed.

Install

Install with npm

$ npm i strip-comments --save

Usage

var strip = require('strip-comments');
console.log(strip('Hey! // foo'));
//=> 'Hey !';

API

strip

Strip comments from the given string.

Params

• string {String}
• options {Object}: Pass safe: true to keep comments with !
• returns {String}

Example

console.log(strip("foo // this is a comment\n/* me too */"));
//=> 'foo'

block

Strip block comments from the given string.

Params

• string {String}
• options {Object}: Pass safe: true to keep comments with !
• returns {String}

Example

console.log(strip.block("foo // this is a comment\n/* me too */"));
//=> 'foo // this is a comment\n'

line

Strip line comments from the given string.

Params

• string {String}
• options {Object}: Pass safe: true to keep comments with !
• returns {String}

Example

console.log(strip.line("foo /* me too */"));
//=> 'foo'

first

Strip the first comment from the given string.

Params

• string {String}
• options {Object}: Pass safe: true to keep comments with !
• returns {String}

Related projects

• code-context: Parse a string of javascript to determine the context for functions, variables and comments based… more | homepage
• esprima-extract-comments: Extract code comments from string or from a glob of files using esprima. | homepage
• extract-comments: Extract code comments from string or from a glob of files. | homepage
• js-comments: Parse JavaScript code comments and generate API documentation. | homepage
• parse-code-context: Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… more | homepage
• parse-comments: Parse code comments from JavaScript or any language that uses the same format. | homepage
• snapdragon: snapdragon is an extremely pluggable, powerful and easy-to-use parser-renderer factory. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on November 04, 2015.