# webpack-minimal-classnames

> Generate small css class names with webpack css-loader

Latest version **2.1.1** (published 2022-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install webpack-minimal-classnames
pnpm add webpack-minimal-classnames
yarn add webpack-minimal-classnames
bun add webpack-minimal-classnames
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2022-02-04 |
| First published | 2018-08-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Garth Poitras |
| Maintainers | gdub |
| Keywords | webpack, css, css-modules, css-loader, minification |

## Links

- npm: https://www.npmjs.com/package/webpack-minimal-classnames
- Repository: https://github.com/neatsoftware/webpack-minimal-classnames
- Homepage: https://github.com/neatsoftware/webpack-minimal-classnames#readme
- Issues: https://github.com/neatsoftware/webpack-minimal-classnames/issues
- npm.io page: https://npm.io/package/webpack-minimal-classnames

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 2.1.1 (latest) — 2022-02-04
- 2.1.0 — 2022-02-03
- 2.0.0 — 2020-02-27
- 1.0.2 — 2019-06-05
- 1.0.1 — 2018-08-17
- 1.0.0 — 2018-08-17

## README

# Webpack Minimal Classnames

Generate small css class names when using css modules with webpack css-loader.  
Recommended to do only doing during production builds as a minification step.  
This differs from simply using css-loader's `[hash:base64:n]` by handling any collisions & allowing to configure excluded names.

### Example

Input:

```css
.someLongDescriptiveCssClassName {
  color: red;
}
.anotherLongDescriptiveCssClassName {
  color: green;
}
```

Output:

```css
.xDK {
  color: red;
}
.zyv {
  color: green;
}
```

### Usage

```js
const MinimalClassnameGenerator = require('webpack-minimal-classnames')

const generateMinimalClassname = MinimalClassnameGenerator({
  length: 3,
  excludePatterns: [/ad/i]
})

{
  test: /\.css$/,
  loaders: [
    {
      loader: 'css-loader',
      options: {
        modules: {
          getLocalIdent: generateMinimalClassname
        }
      }
    }
  ]
}
```

### Options

**length** _(number)_ - Length of generated class names  
default: 3  
_If the max number of names is generated for a given length, it will start generating more at an incremented length_

**excludePatterns** _(RegExp[])_ - Array of regex patterns to exclude generating as a class name

---
_Source: https://npm.io/package/webpack-minimal-classnames · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._