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. Remove both line comments and block comments.

Should work with any language that uses the same syntax, e.g. JavaScript, LESS, SASS/SCSS, CSS.

Install

npm

 npm i strip-comments --save

bower

 npm install strip-comments --save

API

Table of contents

• strip
• strip.block()
• strip.line()

strip(str[, opts])

Strip all comments

• str {String} file content or string to strip to
• opts {Object} options are passed to .block, and .line
• return {String}

Example:

/*!
 * this multiline
 * block comment ('top banner')
 */

'use strict';

/**!
 * and this multiline
 * block comment
 */
var foo = function(/* and these single-line block comments */) {};

/**
 * and this multiline
 * block comment
 */
var bar = function(/* and these single-line block comments */) {};

// this single-line line comment
var baz = function () {
  // this multiline
  // line comment
  var some = true;
  //this
  var fafa = true; //and this
  // var also = 'that';
  var but = 'not'; //! that comment
};

// also this multiline
// line comment
var fun = false;

Source:

var strip = module.exports = function(str, opts) {
  return str ? strip.block(strip.line(str, opts), opts) : '';
};

strip.block(str[, opts])

Strip only block comments

• str {String} file content or string to strip to
• opts {Object} if safe:true, strip only that not starts with /*! or /**!
• return {String}

Example:

/**
 * this multiline
 * block comment
 */
var bar = function(/* and these single-line block comment */) {
  /**
   * also that comment
   */
  var str = 'something'
};

Source:

strip.block = function(str, opts) {
  opts = opts || {};
  var re = new RegExp(reBlock + reBlockEnd, 'gm');
  if(opts.safe) {
    re = new RegExp(reBlockIgnore + reBlockEnd, 'gm');
  }
  return str ? str.replace(re, '') : '';
};

strip.line(str[, opts])

Strip only line comments

• str {String} file content or string to strip to
• opts {Object} if safe:true, strip all that not starts with //!
• return {String}

Example:

// this single-line line comment
var baz = function () {
  // this multiline
  // line comment
  var some = true;
  //this
  var fafa = true; //and this
  // var also = 'that';
  var but = 'not'; //! that comment
};

Source:

strip.line = function(str, opts) {
  opts = opts || {};
  var re = new RegExp(reLine, 'gm');
  if(opts.safe) {
    re = new RegExp(reLineIgnore, 'gm');
  }
  return str ? str.replace(re, '') : '';
};

Tests

mocha -R spec

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors. Released under the MIT license

Changelog

[0.2.0] - 2014-08-10

• fixes use strict statement