strip-comments
Advanced tools
Package description
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.
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);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.
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 line and/or block comments from a string. Blazing fast, and works with JavaScript, Sass, CSS, Less.js, and a number of other languages.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
(TOC generated by verb using markdown-toc)
Install with npm (requires Node.js >=10):
$ npm install --save strip-comments
Takes a string and returns a new string with comments removed. Works with line comments and/or block comments. Optionally removes the first comment only or ignores protected comments.
Works with:
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
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 commentsoptions {Object}: optional options, passed to extract-commentsline {Boolean}: if false strip only block comments, default trueblock {Boolean}: if false strip only line comments, default truekeepProtected {Boolean}: Keep ignored comments (e.g. /*! and //!)preserveNewlines {Boolean}: Preserve newlines after comments are strippedreturns {String}: modified inputExample
const str = strip('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";'
Strip only block comments.
Params
input {String}: string from which to strip commentsoptions {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. /*!)returns {String}: modified stringExample
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'
Strip only line comments.
Params
input {String}: string from which to strip commentsoptions {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. //!)returns {String}: modified stringExample
const str = strip.line('const foo = "bar";// this is a comment\n /* me too */');
console.log(str);
// => 'const foo = "bar";\n/* me too */'
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; '
Parses a string and returns a basic CST (Concrete Syntax Tree).
Params
input {String}: string from which to strip commentsoptions {Object}: pass opts.keepProtected: true to keep ignored comments (e.g. /*!)returns {String}: modified stringExample
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'
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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:
| Commits | Contributor |
|---|---|
| 82 | jonschlinkert |
| 4 | tunnckoCore |
| 2 | mk-pmb |
| 1 | kgryte |
| 1 | briandipalma |
| 1 | epicoxymoron |
| 1 | XuluWarrior |
Jon Schlinkert
Copyright © 2019, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on November 13, 2019.
FAQs
Strip line and/or block comments from a string. Blazing fast, and works with JavaScript, Sass, CSS, Less.js, and a number of other languages.
The npm package strip-comments receives a total of 3,648,786 weekly downloads. As such, strip-comments popularity was classified as popular.
We found that strip-comments demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.