Purgecss plugin for purgecss
Clone or download
Ffloriel Merge pull request #11 from FullHuman/greenkeeper/babel-eslint-10.0.0
Update babel-eslint to the latest version 🚀
Latest commit 5f51d7c Oct 31, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci initial commit May 27, 2018
__tests__ initial commit May 27, 2018
lib v1.1.0 Sep 19, 2018
src initial commit May 27, 2018
.babelrc v1.1.0 Sep 19, 2018
.eslintrc initial commit May 27, 2018
.flowconfig initial commit May 27, 2018
.gitignore initial commit May 27, 2018
.npmrc initial commit May 27, 2018
.travis.yml initial commit May 27, 2018
CHANGELOG.md v1.1.0 Sep 19, 2018
LICENSE initial commit May 27, 2018
README.md docs(readme): add Greenkeeper badge Jul 3, 2018
jest.config.js add jest config file Jul 31, 2018
package.json Merge pull request #11 from FullHuman/greenkeeper/babel-eslint-10.0.0 Oct 31, 2018
rollup.config.js initial commit May 27, 2018

README.md

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.

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.