Skip to content

Commit d7f8d78

Browse files
committed
docs: tweaks
1 parent 7467dc2 commit d7f8d78

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# :snake: css-codemod
22

3-
css-codemod is a toolkit for running codemods over many CSS files to transform code.
4-
5-
Powered by [PostCSS](https://postcss.org):
3+
css-codemod is a toolkit for running codemods over many CSS files to transform code, powered by [PostCSS](https://postcss.org):
64

75
- Any [PostCSS syntax parser and stringifier](https://github.com/postcss/postcss/blob/main/docs/syntax.md) can be added. This extends support for additional syntaxes like SASS and LESS.
8-
- Any [PostCSS plugin](https://github.com/postcss/postcss/blob/main/docs/plugins.md) can be added. This allows running any plugin as a one-off transform. This can be useful if you want to run a plugin once and remove it from a build tool.
9-
- Any [PostCSS helpers](https://postcss.org/api/) for working with nodes and the abstract syntax tree can be used to transform CSS.
6+
- Any [PostCSS plugin](https://github.com/postcss/postcss/blob/main/docs/plugins.md) can be added. This allows running any plugin as a one-off transform. This can be useful if you want to run a plugin once and remove it from a build tool or convert between syntaxes.
7+
- Any [PostCSS helpers](https://postcss.org/api/) for working with nodes and the abstract syntax tree can be used to transform CSS arbitrarily to fit your needs.
8+
- Custom helpers provided by css-codemod to streamline some types of transforms.
109

1110
## Install
1211

@@ -172,8 +171,7 @@ export const transform: Transform = (fileInfo, api) => {
172171
export const parser = parse;
173172

174173
// Note: in this example the `postcss-calc` package is used to compute `calc` expressions.
175-
// This is used only as an example. Say you wanted to simplify all the complex `calc`
176-
// expressions? Or, maybe you want to remove a plugin from the build pipeline and run it once?
174+
// This is used only as an example.
177175
// API docs: https://postcss.org/api/#acceptedplugin
178176
// Plugin docs: https://github.com/postcss/postcss/blob/main/docs/plugins.md
179177
export const plugins = [calc({})];

0 commit comments

Comments
 (0)