70 lines
3.0 KiB
Markdown
70 lines
3.0 KiB
Markdown
<img align="right" width="111" height="111"
|
||
alt="CSSTree logo"
|
||
src="https://cloud.githubusercontent.com/assets/270491/19243723/6f9136c6-8f21-11e6-82ac-eeeee4c6c452.png"/>
|
||
|
||
# CSSTree
|
||
|
||
[](https://www.npmjs.com/package/css-tree)
|
||
[](https://travis-ci.org/csstree/csstree)
|
||
[](https://coveralls.io/github/csstree/csstree?branch=master)
|
||
[](https://gitter.im/csstree/csstree)
|
||
[](https://twitter.com/csstree)
|
||
|
||
The set of tools for working with CSS, including [fast](https://github.com/postcss/benchmark) detailed parser (string->AST), walkers, generators (AST->string) and even lexer (validation and matching) based on knowledge of spec and browser implementations (see [schema](#top-level-api) for details). The main goal to be efficient and W3C spec complient, with focus on analyzing and source-to-source processing.
|
||
|
||
> Work in progress. The project in alpha stage since some parts need further experiments, AST format and API are subjects to change. However it's stable enough and used by packages like [CSSO](https://github.com/css/csso) (CSS minifier) in production.
|
||
|
||
- [Parsing CSS into AST](docs/parsing.md)
|
||
- [AST format](docs/ast.md)
|
||
- [Translate AST to string](docs/translate.md)
|
||
- [AST traversal](docs/traversal.md)
|
||
- [Utils to work with AST](docs/utils.md)
|
||
|
||
Docs and tools:
|
||
|
||
* [AST Explorer](https://astexplorer.net/#/gist/244e2fb4da940df52bf0f4b94277db44/e79aff44611020b22cfd9708f3a99ce09b7d67a8) – explore CSSTree AST format with zero setup
|
||
* [CSS syntax reference](https://csstree.github.io/docs/syntax.html)
|
||
* [CSS syntax validator](https://csstree.github.io/docs/validator.html)
|
||
|
||
Related projects:
|
||
|
||
* [csstree-validator](https://github.com/csstree/validator) – NPM package to validate CSS
|
||
* [stylelint-csstree-validator](https://github.com/csstree/stylelint-validator) – plugin for stylelint to validate CSS
|
||
* [Grunt plugin](https://github.com/sergejmueller/grunt-csstree-validator)
|
||
* [Gulp plugin](https://github.com/csstree/gulp-csstree)
|
||
* [Sublime plugin](https://github.com/csstree/SublimeLinter-contrib-csstree)
|
||
* [VS Code plugin](https://github.com/csstree/vscode-plugin)
|
||
* [Atom plugin](https://github.com/csstree/atom-plugin)
|
||
|
||
## Install
|
||
|
||
```
|
||
> npm install css-tree
|
||
```
|
||
|
||
## Usage
|
||
|
||
```js
|
||
var csstree = require('css-tree');
|
||
var ast = csstree.parse('.example { world: "!" }');
|
||
|
||
csstree.walk(ast, function(node) {
|
||
if (node.type === 'ClassSelector' && node.name === 'example') {
|
||
node.name = 'hello';
|
||
}
|
||
});
|
||
|
||
console.log(csstree.translate(ast));
|
||
// .hello{world:"!"}
|
||
```
|
||
|
||
## Top level API
|
||
|
||
|
||
|
||
## License
|
||
|
||
MIT
|
||
|
||
Syntax matching uses [mdn/data](https://github.com/mdn/data) by Mozilla Contributors
|