strip-comments

What is strip-comments?

The strip-comments npm package is designed to remove comments from code. It supports stripping both line comments and block comments from source code strings, making it useful for cleaning up code or preparing it for minification.

What are strip-comments's main functionalities?

Remove line comments

This feature allows you to remove single line comments from your code. It's particularly useful for cleaning up code by removing unnecessary or explanatory comments that are not needed in production.

"use strict";\n// This is a line comment\nconst x = 1;\n// Another comment\nconsole.log(x);

Remove block comments

This feature enables the removal of block comments, which can span multiple lines. It's useful for eliminating large sections of commented-out code or detailed explanations that are not required in the final codebase.

"use strict";\n/* This is a block comment\n that spans multiple lines */\nconst x = 1;\nconsole.log(x);

Preserve important comments

Strip-comments can be configured to preserve comments that are marked as important, usually with a specific syntax like `/*!`. This is useful for keeping license information or other critical comments while removing the rest.

"use strict";\n/*! Preserve this comment */\n// This is a line comment\nconst x = 1;\nconsole.log(x);

Other packages similar to strip-comments

esprima

Esprima is a JavaScript parser that can be used to analyze and manipulate JavaScript code. While not specifically designed for removing comments, it can be used to parse code, manipulate the AST (Abstract Syntax Tree), and then regenerate the code without comments. It offers more flexibility but is more complex than strip-comments.

uglify-js

UglifyJS is a JavaScript minifier that can remove comments as part of its minification process. It provides more comprehensive code optimization features beyond just comment removal, including variable name mangling and dead code elimination. Compared to strip-comments, it's a more powerful tool for preparing code for production but might be overkill for just comment removal.

README

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.