# icss-utils

> ICSS utils for postcss ast

Latest version **5.1.0** (published 2020-11-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install icss-utils
pnpm add icss-utils
yarn add icss-utils
bun add icss-utils
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2020-11-19 |
| First published | 2017-05-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/icss-utils) |
| Module format | CommonJS |
| Node | ^10 \|\| ^12 \|\| >= 14 |
| Dependencies | 0 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Glen Maddern |
| Maintainers | trysound, sullenor, geelen, evilebottnawi |
| Keywords | css, modules, icss, postcss |

## Links

- npm: https://www.npmjs.com/package/icss-utils
- Repository: https://github.com/css-modules/icss-utils
- Homepage: https://github.com/css-modules/icss-utils#readme
- Issues: https://github.com/css-modules/icss-utils/issues
- npm.io page: https://npm.io/package/icss-utils

## 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

- 5.1.0 (latest) — 2020-11-19
- 5.0.0-rc.0 (next) — 2020-09-22
- 5.0.0 — 2020-10-12
- 4.1.1 — 2019-05-29
- 4.1.0 — 2019-02-26
- 4.0.0 — 2018-11-01
- 3.0.1 — 2017-06-14
- 3.0.0 — 2017-06-14
- 2.1.0 — 2017-05-26
- 2.0.0 — 2017-05-24

## README

[![Build Status](https://travis-ci.org/css-modules/icss-utils.svg)](https://travis-ci.org/css-modules/icss-utils)

# ICSS Utils

## replaceSymbols

Governs the way tokens are searched & replaced during the linking stage of ICSS loading.

This is broken into its own module in case the behaviour needs to be replicated in other PostCSS plugins
(i.e. [CSS Modules Values](https://github.com/css-modules/postcss-modules-values))

```js
import { replaceSymbols, replaceValueSymbols } from "icss-utils";

replaceSymbols(css, replacements);
replaceValueSymbols(string, replacements);
```

Where:

- `css` is the PostCSS tree you're working with
- `replacements` is an JS object of `symbol: "replacement"` pairs, where all occurrences of `symbol` are replaced with `replacement`.

A symbol is a string of alphanumeric, `-` or `_` characters. A replacement can be any string. They are replaced in the following places:

- In the value of a declaration, i.e. `color: my_symbol;` or `box-shadow: 0 0 blur spread shadow-color`
- In a media expression i.e. `@media small {}` or `@media screen and not-large {}`

## extractICSS(css, removeRules = true, mode = 'auto')

Extracts and remove (if removeRules is equal true) from PostCSS tree `:import`, `@icss-import`, `:export` and `@icss-export` statements.

```js
import postcss from "postcss";
import { extractICSS } from "icss-utils";

const css = postcss.parse(`
  :import(colors) {
    a: b;
  }
  :export {
    c: d;
  }
`);

extractICSS(css);
/*
  {
    icssImports: {
      colors: {
        a: 'b'
      }
    },
    icssExports: {
      c: 'd'
    }
  }
*/
```

By default both the pseudo and at-rule form of the import and export statements
will be removed. Pass the `mode` option to limit to only one type.

## createICSSRules(icssImports, icssExports, mode = 'rule')

Converts icss imports and exports definitions to postcss ast

```js
createICSSRules(
  {
    colors: {
      a: "b",
    },
  },
  {
    c: "d",
  },
  // Need pass `rule` and `decl` from postcss
  // Please look at `Step 4` https://evilmartians.com/chronicles/postcss-8-plugin-migration
  postcss
);
```

By default it will create pseudo selector rules (`:import` and `:export`). Pass
`at-rule` for `mode` to instead generate `@icss-import` and `@icss-export`, which
may be more resilient to post processing by other tools.

## License

ISC

---

Glen Maddern, Bogdan Chadkin and Evilebottnawi 2015-present.

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