website/node_modules/postcss-discard-unused/README.md

In JohnCoene/chirp: 'Twitter' Networks Analyser

postcss-discard-unused

Discard unused counter styles, keyframes and fonts.

Install

With npm do:

npm install postcss-discard-unused --save

Example

This module will discard unused at rules in your CSS file, if it cannot find any selectors that make use of them. It works on @counter-style, @keyframes and @font-face.

Input

@counter-style custom {
    system: extends decimal;
    suffix: "> "
}

@counter-style custom2 {
    system: extends decimal;
    suffix: "| "
}

a {
    list-style: custom
}

Output

@counter-style custom {
    system: extends decimal;
    suffix: "> "
}

a {
    list-style: custom
}

Note that this plugin is not responsible for normalising font families, as it makes the assumption that you will write your font names consistently, such that it considers these two declarations differently:

h1 {
    font-family: "Helvetica Neue"
}

h2 {
    font-family: Helvetica Neue
}

However, you can mitigate this by including postcss-minify-font-values before this plugin, which will take care of normalising quotes, and deduplicating. For more examples, see the tests.

Usage

See the PostCSS documentation for examples for your environment.

API

discardUnused([options])

options

fontFace

Type: boolean Default: true

Pass false to disable discarding unused font face rules.

counterStyle

Type: boolean Default: true

Pass false to disable discarding unused counter style rules.

keyframes

Type: boolean Default: true

Pass false to disable discarding unused keyframe rules.

namespace

Type: boolean Default: true

Pass false to disable discarding unused namespace rules.

Contributors

Thanks goes to these wonderful people (emoji key):

| Ben Briggs💻 📖 👀 ⚠️ | Bogdan Chadkin💻 📖 👀 ⚠️ | Paweł Lesiecki💻 ⚠️ | Thomas McDonald💻 ⚠️ | | :---: | :---: | :---: | :---: |

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © Ben Briggs

JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.