Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

postcss-discard-comments

Package Overview
Dependencies
0
Maintainers
8
Versions
47
Issues
File Explorer

Advanced tools

postcss-discard-comments

Discard comments in your CSS files with PostCSS.

    5.1.2latest

Version published
Maintainers
8
Weekly downloads
10,195,072
decreased by-12.92%

Weekly downloads

Changelog

Source

v5.1.2

Bug fixes

  • preserve empty custom properties and ensure they work in Chrome (4ed39679)

Readme

Source

postcss-discard-comments

Discard comments in your CSS files with PostCSS.

Install

With npm do:

npm install postcss-discard-comments --save

Example

Input

h1/* heading */{ margin: 0 auto }

Output

h1 { margin: 0 auto }

This module discards comments from your CSS files; by default, it will remove all regular comments (/* comment */) and preserve comments marked as important (/*! important */).

Note that this module does not handle source map comments because they are not available to it; PostCSS handles this internally, so if they are removed then you will have to configure source maps in PostCSS.

API

comments([options])

options
remove(function)

Type: function Return: boolean Variable: comment contains a comment without /**/

For each comment, return true to remove, or false to keep the comment.

function(comment) {} var css = '/* headings *//*@ h1 */h1{margin:0 auto}/*@ h2 */h2{color:red}'; console.log(postcss(comments({ remove: function(comment) { return comment[0] == "@"; } })).process(css).css); //=> /* headings */h1{margin:0 auto}h2{color:red}

NOTE: If you use the remove function other options will not be available.

removeAll

Type: boolean Default: false

Remove all comments marked as important.

var css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}'; console.log(postcss(comments({removeAll: true})).process(css).css); //=> h1{margin:0 auto}h2{color:red}
removeAllButFirst

Type: boolean Default: false

Remove all comments marked as important, but the first one.

var css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}'; console.log(postcss(comments({removeAllButFirst: true})).process(css).css); //=> /*! heading */h1{margin:0 auto}h2{color:red}

Usage

See the PostCSS documentation for examples for your environment.

Contributors

See CONTRIBUTORS.md.

License

MIT © Ben Briggs

Keywords

FAQs

What is postcss-discard-comments?

Discard comments in your CSS files with PostCSS.

Is postcss-discard-comments popular?

The npm package postcss-discard-comments receives a total of 8,207,212 weekly downloads. As such, postcss-discard-comments popularity was classified as popular.

Is postcss-discard-comments well maintained?

We found that postcss-discard-comments demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 8 open source maintainers collaborating on the project.

Last updated on 29 May 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc