# postcss-rename

**Repository Path**: mirrors_google/postcss-rename

## Basic Information

- **Project Name**: postcss-rename
- **Description**: Replace class names based on a customizable renaming scheme.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build status](https://github.com/google/postcss-rename/actions/workflows/ci.yml/badge.svg)](https://github.com/google/postcss-rename/actions)

A [PostCSS](https://github.com/postcss/postcss) plugin to replace CSS names
based on a customizable renaming scheme.

* [Getting Started](#getting-started)
* [Usage](#usage)
* [Options](#options)
  * [`strategy`](#strategy)
  * [`by`](#by)
  * [`prefix`](#prefix)
  * [`except`](#except)
  * [`ids`](#ids)
  * [`outputMapCallback`](#outputMapCallback)

## Getting Started
If using TypeScript, you will need `"moduleResolution"` to be `"node16"` or
higher.

Install the plugin using npm

```
npm install --save-dev postcss postcss-rename
```

You can insert these plugins into your PostCSS stack

```cjs
const postcss = require('postcss');
const classRename = require('postcss-rename');
const variableRename = require('postcss-rename/variable');

const myProcessedCss = postcss([
    classRename({ /* class renaming options here, see Options */ }),
    variableRename({ /* variable renaming options here, see Options */ }),
]).process(input).css;
```


## Usage

`postcss-rename` makes it possible to rename CSS names in the generated
stylesheet, which helps reduce the size of the CSS that is sent down to your
users. It's designed to be used along with a plugin for a build system like
Webpack that can rewrite HTML templates and/or references in JS. If you write
such a plugin, let us know and we'll link it here!

## Options

### `strategy`

The renaming strategy to use:

* `"none"`: Don't change names at all. This is the default strategy.

* `"debug"`: Add an underscore at the end of each name. This is useful for
  keeping classes readable during debugging while still verifying that your
  templates and JavaScript aren't accidentally using non-renamed classes.

* `"minimal"`: Use the shortest possible names, in order of appearance: the
  first class is renamed to `.a`, the second to `.b`, and so on.

This can also be a function that takes a CSS name (the full name in by-whole
mode and the part in by-part mode) and returns its renamed value.

### `by`

> *Note*: this option only works for selector renaming.

Whether to rename in "by-whole mode" or "by-part mode".

* `"whole"`: Rename the entire name at once, so for example `.tall-image` might
  become `.a`. This is the default mode.

* `"part"`: Rename each hyphenated section of a name separately, so for example
  `.tall-image` might become `.a-b`.

This only applies to classes, and variables are always renamed in "by-whole
mode"

### `prefix`

A string prefix to add before every renamed class. This applies even if
[`strategy`](#strategy) is set to `none`.

In by-part mode, the prefix is applied to the entire class, but it isn't
included in the [output map](#outputMapCallback).

When a prefix is given while renaming variables, a dash ("-") is added in
between the prefix and the renamed CSS variable.

### `except`

An array (or other `Iterable`) of names that shouldn't be renamed.

### `ids`

> *Note*: this option only works for selector renaming.

Whether to rename ID selectors as well as class selectors. Defaults to `false`.
This does not apply to variable renaming.

### `outputMapCallback`

A callback that's passed a map from original class names to their renamed
equivalents, so that an HTML template or JS class references can also be
renamed.

In by-part mode, this contains separate entries for each part of a class name.
It doesn't contain any names that weren't renamed because of
[`except`](#except).

Disclaimer: This is not an officially supported Google product.