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

3.0.0 • Public • Published

parcel-plugin-purgecss

A Parcel plugin to remove unused rules from your bundled CSS files.

How it works

This plugin uses purgecss to remove unused CSS rules.

It works by reading your source files and checking which CSS selectors are mentioned in your HTML and Javascript code.

This is very useful if you're using a full-featured CSS framework like Bootstrap or Materialize, or even Atomic CSS libraries like Tachyons or BassCSS since you might not use all the provided components and helpers.

Usage

  1. Install the plugin as a dependency in your package.json.
  2. Create a purgecss.config.js file in the root of your module and fill it out with the options you need from PurgeCSS. Note that the content option is required. You can also add your options to a purgecss key on your package.json.
  3. Build normally

This plugin is only enabled when minify: true, which means it won't run on parcel serve.

Options

They are passed directly to the purgecss postcss plugin. Here's a list of the available options.

purgecss.config.js:

module.exports = {
  content: ["**/*.html"],
  whitelist: ["my-very-special-class"],
}

Note that whitelisting applies to any element, id, or class that matches the provided names, as mentioned in the purgecss docs.

Installation

yarn add --dev parcel-bundler parcel-plugin-purgecss

or

npm install -D parcel-bundler parcel-plugin-purgecss

parcel-bundler is a peer dependency.

Known issues

The entry stylesheet must be in your package. That means that if you have a stylesheet of your npm dependencies directly from a JS or HTML file, it will not be purged. If you import it directly or indirectly from another stylesheet in your main package (or SASS, Stylus, etc.), it's fine.

Package Sidebar

Install

npm i parcel-plugin-purgecss

Weekly Downloads

88

Version

3.0.0

License

MIT

Unpacked Size

5.79 kB

Total Files

10

Last publish

Collaborators

  • cprecioso