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.
Changelog
[0.4.4] - 2016-02-14
Readme
Strip comments from code. Removes line comments, block comments, the first comment only, or all comments. Optionally leave protected comments unharmed.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm i strip-comments --save
For more use-cases see the tests
var strip = require('strip-comments');
console.log(strip('Hey! // foo'));
//=> 'Hey !';
Strip all code comments from the given input, including these that are ignored. Pass opts.safe: true to keep them.
Params
<input> {String}: string from which to strip comments
opts {Object}: optional options, passed to [extract-comments][extract-comments]
line {Boolean}: if false strip only block comments, default trueblock {Boolean}: if false strip only line comments, default truesafe {Boolean}: pass true to keep ignored comments (e.g. /*! and //!)preserveNewlines {Boolean}: if true preserve newlines after comments are strippedreturns {String}: modified input
Example
var str = strip('foo; // this is a comment\n /* me too *\/');
console.log(str);
// => 'foo; \n '
Strip only block comments.
Params
<input> {String}: string from which to strip comments[opts] {Object}: pass opts.safe: true to keep ignored comments (e.g. /*!)returns {String}: modified stringExamples
var output = strip('foo; // this is a comment\n /* me too *\/', { line: false });
console.log(output);
// => 'foo; // this is a comment\n '
var output = strip.block('foo; // this is a comment\n /* me too *\/');
console.log(output);
// => 'foo; // this is a comment\n '
Strip only line comments.
Params
<input> {String}: string from which to strip comments[opts] {Object}: pass opts.safe: true to keep ignored comments (e.g. //!)returns {String}: modified stringExamples
var output = strip('foo; // this is a comment\n /* me too *\/', { block: false });
console.log(output);
// => 'foo; \n /* me too *\/'
var output = strip.line('foo; // this is a comment\n /* me too *\/');
console.log(output);
// => 'foo; \n /* me too *\/'
Strip the first comment from the given input. If opts.safe: true is passed, will strip the first that is not ignored.
Params
<input> {String}[opts] {Object}: pass opts.safe: true to keep comments with !returns {String}Examples
var str = '//! first comment\nfoo; // this is a comment';
var output = strip(str, {
first: true
});
console.log(output);
// => '\nfoo; // this is a comment'
var str = '//! first comment\nfoo; // this is a comment';
var output = strip.first(str, { safe: true });
console.log(output);
// => '//! first comment\nfoo; '
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2014-2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on February 14, 2016.
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,522,315 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
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.