strip-css-comments

WebJar for strip-css-comments

License	MIT
GroupId	org.webjars.npm
ArtifactId	strip-css-comments
Last Version	3.0.0
Release Date	Aug 24, 2019
Type	jar
Description	strip-css-comments WebJar for strip-css-comments
Project URL	http://webjars.org
Source Code Management	https://github.com/sindresorhus/strip-css-comments

Download strip-css-comments

Filename	Size
strip-css-comments-3.0.0.pom
strip-css-comments-3.0.0.jar	5 KB
strip-css-comments-3.0.0-sources.jar	22 bytes
strip-css-comments-3.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/strip-css-comments/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>strip-css-comments</artifactId>
    <version>3.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/strip-css-comments/
implementation 'org.webjars.npm:strip-css-comments:3.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/strip-css-comments/
implementation ("org.webjars.npm:strip-css-comments:3.0.0")

Apache Buildr

'org.webjars.npm:strip-css-comments:jar:3.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="strip-css-comments" rev="3.0.0">
  <artifact name="strip-css-comments" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='strip-css-comments', version='3.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "strip-css-comments" % "3.0.0"

Leiningen

[org.webjars.npm/strip-css-comments "3.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : is-regexp	jar	[1.0.0,2)

Project Modules

There are no modules declared in this project.

strip-css-comments

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

Related

• strip-css-comments-cli - CLI for this module
• strip-json-comments - Strip comments from JSON

Versions

Version
3.0.0 Aug 24, 2019