Nascent Prototype Metaverse

    postcss-discard-comments
    TypeScript icon, indicating that this package has built-in type declarations

    5.1.2 • Public • Published

    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

    Install

    npm i postcss-discard-comments

    DownloadsWeekly Downloads

    11,161,317

    Version

    5.1.2

    License

    MIT

    Unpacked Size

    10.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • beneb
    • trysound
    • ludovicofischer
    • ai
    • chriseppstein
    • andyjansson
    • evilebottnawi
    • cssnano-bot