strip-comments

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

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save strip-comments

Usage

By default all comments are stripped.

const strip = require('strip-comments');
const str = strip('const foo = "bar";// this is a comment\n /* me too *\/');
console.log(str);
// => 'const foo = "bar";\n'

For more use-cases see the tests

API

strip

Strip all code comments from the given input, including protected comments that start with !, unless disabled by setting options.keepProtected to true.

Params

input {String}: string from which to strip comments
options {Object}: optional options, passed to extract-comments
returns {String}: modified input

Options

line {Boolean}: if false strip only block comments, default true
block {Boolean}: if false strip only line comments, default true
keepProtected {Boolean}: Keep ignored comments (e.g. /*!, /**! and //!)
preserveNewlines {Boolean}: Preserve newlines after comments are stripped

Example

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

.block

Strip only block comments.

Params

input {String}: string from which to strip comments
options {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. /*!)
returns {String}: modified string

Example

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

.line

Strip only line comments.

Params

input {String}: string from which to strip comments
options {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. //!)
returns {String}: modified string

Example

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

.first

Strip the first comment from the given input. Or, if opts.keepProtected is true, the first non-protected comment will be stripped.

Params

input {String}
options {Object}: pass opts.keepProtected: true to keep comments with !
returns {String}

Example

const output = strip.first(input, { keepProtected: true });
console.log(output);
// => '//! first comment\nfoo; '

About

Contributing

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

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

You might also be interested in these projects:

babel-extract-comments: Uses babel (babylon) to extract JavaScript code comments from a JavaScript string or file. | homepage
code-context: Parse a string of javascript to determine the context for functions, variables and comments based… more | homepage
extract-comments: Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… more | 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