Popularity
2.0
Declining
Activity
4.2
Growing
94
9
8

Monthly Downloads: 0
Programming language: CSS
License: MIT License
Tags: Parsing     String     Css     Transform     Preprocess     Comments     Trim     Delete     Remove     Strip     Stylesheet     Style    
Latest version: v4.1.0

strip-css-comments alternatives and similar modules

Based on the "Parsing" category

Do you think we are missing an alternative of strip-css-comments or a related project?

Add another 'Parsing' Module

README

strip-css-comments Build Status

Strip comments from CSS

Also available as a Gulp/Grunt/Broccoli plugin.

Usage

$ npm install strip-css-comments

Usage

const stripCssComments = require('strip-css-comments');

// By default important comments `/*!` are preserved
stripCssComments('/*! <copyright> */ body { /* unicorns */color: hotpink; }');
//=> '/*! <copyright> */ body { color: hotpink; }'

// `preserve: false` will strip all comments including `/*!`
stripCssComments(
    '/*! <copyright> */ body { /* unicorns */color: hotpink; }',
    {preserve: false}
);
//=> 'body { color: hotpink; }'

// Preserve comments based on a regex
stripCssComments(
    '/*# preserved */ body { /* unicorns */color: hotpink; }',
    {preserve: /^#/}
);
//=> '/*# preserved */ body { color: hotpink; }'

// Preserve comments based on the return value of the supplied function
stripCssComments(
    '/*# preserved */ body { /* unicorns */color: hotpink; }',
    {
        preserve: comment => comment.charAt(0) === '#'
    }
);
//=> '/*# preserved */ body { color: hotpink; }'

API

stripCssComments(cssString, options?)

cssString

Type: string

String with CSS.

options

Type: object

preserve

Type: boolean | RegExp | Function\ Default: true

  • true - Preserve important comments /*! */.
  • false - Strip all comments.
  • RegExp - Preserve comments where the comment body matches a regular expression.
  • Function - Preserve comments for which a function returns true. The function is called on each comment, gets the comment body as the first argument, and is expected to return a boolean of whether to preserve the comment.

whitespace

Type: boolean\ Default: true

Replace comments with whitespace instead of stripping them entirely.

Benchmark

$ npm run bench