dab7914eab
* Commit updated Javascript packages * Bump preact from 10.5.4 to 10.5.5 in /build/javascript (#265) * Trying a new github workflow to install javascript packages * Bump tailwindcss from 1.9.2 to 1.9.4 in /build/javascript (#266) Bumps [tailwindcss](https://github.com/tailwindlabs/tailwindcss) from 1.9.2 to 1.9.4. - [Release notes](https://github.com/tailwindlabs/tailwindcss/releases) - [Changelog](https://github.com/tailwindlabs/tailwindcss/blob/master/CHANGELOG.md) - [Commits](https://github.com/tailwindlabs/tailwindcss/compare/v1.9.2...v1.9.4) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Commit updated Javascript packages * Bump preact from 10.5.4 to 10.5.5 in /build/javascript Bumps [preact](https://github.com/preactjs/preact) from 10.5.4 to 10.5.5. - [Release notes](https://github.com/preactjs/preact/releases) - [Commits](https://github.com/preactjs/preact/compare/10.5.4...10.5.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> * Bump @justinribeiro/lite-youtube in /build/javascript Bumps [@justinribeiro/lite-youtube](https://github.com/justinribeiro/lite-youtube) from 0.9.0 to 0.9.1. - [Release notes](https://github.com/justinribeiro/lite-youtube/releases) - [Commits](https://github.com/justinribeiro/lite-youtube/commits) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com>
107 lines
3.4 KiB
Markdown
107 lines
3.4 KiB
Markdown
# PostCSS Purgecss
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[PostCSS] plugin for PurgeCSS.
|
|
|
|
[PostCSS]: https://github.com/postcss/postcss
|
|
|
|
## Installation
|
|
|
|
```
|
|
npm i -D @fullhuman/postcss-purgecss
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
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](https://www.purgecss.com/configuration.html#options).
|
|
|
|
### `content` (**required** or use `contentFunction` instead)
|
|
Type: `Array<string>`
|
|
|
|
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.
|
|
|
|
### `contentFunction` (as alternative to `content`)
|
|
Type: `(sourceInputFile: string) => Array<string>`
|
|
|
|
The function receives the current source input file. With this you may provide a specific array of globs for each input. E.g. for
|
|
an angular application only scan the components template counterpart for every component scss file:
|
|
|
|
```js
|
|
purgecss({
|
|
contentFunction: (sourceInputFileName: string) => {
|
|
if (/component\.scss$/.test(sourceInputFileName))
|
|
return [sourceInputFileName.replace(/scss$/, 'html')]
|
|
else
|
|
return ['./src/**/*.html']
|
|
},
|
|
})
|
|
```
|
|
|
|
### `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](https://www.purgecss.com/extractors.html).
|
|
|
|
### `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`](https://github.com/postcss/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](./../../CONTRIBUTING.md) for details on our code of
|
|
conduct, and the process for submitting pull requests to us.
|
|
|
|
## Versioning
|
|
|
|
postcss-purgecss use [SemVer](http://semver.org/) for versioning.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](./../../LICENSE) file
|
|
for details.
|