Have ideas to improve npm?Join in the discussion! »

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

    2.0.3 • Public • Published

    PostCSS Purgecss

    Build Status CircleCi dependencies Status devDependencies Status Codacy Badge Codacy Badge styled with prettier npm license Greenkeeper badge

    PostCSS plugin for PurgeCSS.

    Installation

    npm i -D @fullhuman/postcss-purgecss
    

    Usage

    const purgecss = require('@fullhuman/postcss-purgecss')
    postcss([
      purgecss({
        content: ['./src/**/*.html']
      })
    ])

    See PostCSS docs for examples for your environment.

    Options

    All of the options of purgecss are available to use with the plugins. You will find below the main options available. For the complete list, go to the purgecss documentation website.

    content (required)

    Type: string | Object

    You can specify content that should be analyzed by Purgecss with an array of filenames or globs. The files can be HTML, Pug, Blade, etc.

    extractors

    Type: Array<Object>

    Purgecss can be adapted to suit your needs. If you notice a lot of unused CSS is not being removed, you might want to use a custom extractor. More information about extractors here.

    whitelist

    Type: Array<string>

    You can whitelist selectors to stop Purgecss from removing them from your CSS. This can be accomplished with the options whitelist and whitelistPatterns.

    whitelistPatterns

    Type: Array<RegExp>

    You can whitelist selectors based on a regular expression with whitelistPatterns.

    rejected

    Type: boolean Default value: false

    If true, purged selectors will be captured and rendered as PostCSS messages. Use with a PostCSS reporter plugin like postcss-reporter to print the purged selectors to the console as they are processed.

    keyframes

    Type: boolean Default value: false

    If you are using a CSS animation library such as animate.css, you can remove unused keyframes by setting the keyframes option to true.

    fontFace

    Type: boolean Default value: false

    If there are any unused @font-face rules in your css, you can remove them by setting the fontFace option to true.

    Contributing

    Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

    Versioning

    postcss-purgecss use SemVer for versioning.

    License

    This project is licensed under the MIT License - see the LICENSE file for details.

    Keywords

    none

    Install

    npm i postcss-purgecss

    DownloadsWeekly Downloads

    1,306

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    9.81 kB

    Total Files

    7

    Last publish

    Collaborators