decomment

decomment

Removes comments from JSON, JavaScript, CSS and HTML.

Installing

$ npm install decomment

Testing

$ npm test

Testing with coverage:

$ npm run coverage

Usage

var decomment = require('decomment');

var text = "var t; // comments";

decomment(text); //=> var t;

Features

• Removes both single and multi-line comments from JSON, JavaScript and CSS
• Automatically recognizes HTML and removes all <!-- comments --> from it
• Does not change layout / formatting of the original document
• Removes lines that have only comments on them
• Compatible with JSON5 and ECMAScript 6

The library does not support mixed content - HTML with JavaScript or CSS in it. Once the input code is recognized as HTML, only the HTML comments will be removed from it.

Performance

In terms of the performance, this library is as fast as it gets, in part because it makes no use of regular expressions.

For example, it churns through AngularJS 1.5 Core (1.1MB ~ 30,000 lines of JavaScript) in under 40ms.

API

decomment(text, [options]) ⇒ String

options.trim ⇒ Boolean

• false (default) - do not trim comments
• true - remove empty lines that follow removed full-line comments

Examples:

var text = "/* comment */\r\n\r\n var test = 123"; 
decomment(text); //=> \r\n var test = 123
decomment(text, {trim: true}); //=> var test = 123

options.safe ⇒ Boolean

• false (default) - remove all multi-line comments
• true - keep multi-line comments that start with /*!

Examples:

var text = "/*! special */ js code /* normal */";
decomment(text); //=> js code
decomment(text, {safe: true}); //=> /*! special */ js code

This option has no effect when processing HTML.

License

Copyright © 2015 Vitaly Tomilov; Released under the MIT license.