@americanexpress/purgecss-loader/README.md

Webpack loader for removing unused CSS

<h1 align="center">
  <img src='https://github.com/americanexpress/purgecss-loader/raw/main/purgecss-loader.png' alt="purgecss-loader - One Amex" width='50%'/>
</h1>

[![npm version](https://badge.fury.io/js/%40americanexpress%2Fpurgecss-loader.svg)](https://badge.fury.io/js/%40americanexpress%2Fpurgecss-loader)
![Health Check](https://github.com/americanexpress/purgecss-loader/workflows/Health%20Check/badge.svg)

> This [Webpack](https://github.com/webpack/webpack) loader uses [purgecss](https://github.com/FullHuman/purgecss)
to strip unused selectors from your CSS.

## 👩‍💻 Hiring 👨‍💻

> Want to get paid for your contributions to `purgecss-loader`?
> Send your resume to oneamex.careers@aexp.com

## 📖 Table of Contents

* [Features](#-features)
* [Usage](#-usage)
* [API](#%EF%B8%8F-api)
* [License](#%EF%B8%8F-license)
* [Code Of Conduct](#%EF%B8%8F-code-of-conduct)
* [Contributing](#-contributing)

## ✨ Features

* Ability to remove CSS modules
* Ability to remove plain CSS declarations
* Reduce bundle size

## 🤹‍ Usage

```
npm install -D @americanexpress/purgecss-loader
```

## 🎛️ API

### Configure as follows:

```js
module.exports = {
  entry: {...},
  output: {...},
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [
          {
            loader: 'css-loader',
            options: {
              modules: true,
              localIdentName: '[name]__[local]___[hash:base64:5]',
            },
          },
          {
            loader: '@americanexpress/purgecss-loader',
            options: {
              paths: [path.join(somePath, 'src/**/*.{js,jsx}')],
              safelist: [/:global$/],
            },
          },
        ],
      },
    ],
  },
}
```

You should use this with the [`css-loader`](https://github.com/webpack-contrib/css-loader)
as seen above. However, it is not required that you use CSS modules. That is in
the example to express this loader's compatibility.

### Options

| Property        | Description                       | Required |
|-----------------|-----------------------------------|----------|
| `paths`         | An array of file [glob] patterns  | `true`   |
| `extractors`    | An array of [purgecss extractors] | `false`  |
| `fontFace`   | `boolean` (default: false) see [options]     | `false`  |
| `keyframes`  | `boolean` (default: false) see [options] | `false`  |
| `variables`  | `boolean` (default: false) see [options] | `false`  |
| `safelist`  | `UserDefinedSafelist` see [options]| `false`  |
| `blocklist` | `StringRegExpArray` see [options] | `false`  |

[glob]: https://github.com/isaacs/node-glob
[purgecss extractors]: https://www.purgecss.com/extractors.html
[options]: https://purgecss.com/configuration.html#options

## 🗝️ License

Any contributions made under this project will be governed by the
[Apache License 2.0](./LICENSE.txt).

## 🗣️ Code of Conduct

This project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md).
By participating, you are expected to honor these guidelines.

## 🏆 Contributing

We welcome Your interest in the American Express Open Source Community on Github.
Any Contributor to any Open Source Project managed by the American Express Open
Source Community must accept and sign an Agreement indicating agreement to the
terms below. Except for the rights granted in this Agreement to American Express
and to recipients of software distributed by American Express, You reserve all
right, title, and interest, if any, in and to Your Contributions. Please [fill
out the Agreement](https://cla-assistant.io/americanexpress/purgecss-loader).

Please feel free to open pull requests and see [CONTRIBUTING.md](./CONTRIBUTING.md)
for commit formatting details.