Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

css-tree

Package Overview
Dependencies
2
Maintainers
2
Versions
53
Issues
File Explorer

Advanced tools

css-tree

A tool set for CSS: fast detailed parser (CSS → AST), walker (AST traversal), generator (AST → CSS) and lexer (validation and matching) based on specs and browser implementations

    2.2.1latest

Version published
Maintainers
2
Weekly downloads
20,658,056
decreased by-4.03%

Weekly downloads

Changelog

Source

2.2.1 (August 14, 2022)

  • Fixed a regression added in 2.2.0 for at-rule syntax matching when at-rule has no prelude

Readme

Source

CSSTree logo

CSSTree

NPM version Build Status Coverage Status NPM Downloads Twitter

CSSTree is a tool set for CSS: fast detailed parser (CSS → AST), walker (AST traversal), generator (AST → CSS) and lexer (validation and matching) based on specs and browser implementations. The main goal is to be efficient and W3C spec compliant, with focus on CSS analyzing and source-to-source transforming tasks.

Features

  • Detailed parsing with an adjustable level of detail

    By default CSSTree parses CSS as detailed as possible, i.e. each single logical part is representing with its own AST node (see AST format for all possible node types). The parsing detail level can be changed through parser options, for example, you can disable parsing of selectors or declaration values for component parts.

  • Tolerant to errors by design

    Parser behaves as spec says: "When errors occur in CSS, the parser attempts to recover gracefully, throwing away only the minimum amount of content before returning to parsing as normal". The only thing the parser departs from the specification is that it doesn't throw away bad content, but wraps it in a special node type (Raw) that allows processing it later.

  • Fast and efficient

    CSSTree is created with focus on performance and effective memory consumption. Therefore it's one of the fastest CSS parsers at the moment.

  • Syntax validation

    The build-in lexer can test CSS against syntaxes defined by W3C. CSSTree uses mdn/data as a basis for lexer's dictionaries and extends it with vendor specific and legacy syntaxes. Lexer can only check the declaration values currently, but this feature will be extended to other parts of the CSS in the future.

Projects using CSSTree

  • Svelte – Cybernetically enhanced web apps
  • SVGO – Node.js tool for optimizing SVG files
  • CSSO – CSS minifier with structural optimizations
  • NativeScript – NativeScript empowers you to access native APIs from JavaScript directly
  • react-native-svg – SVG library for React Native, React Native Web, and plain React web projects
  • penthouse – Critical Path CSS Generator
  • Bit – Bit is the platform for collaborating on components
  • and more...

Documentation

Tools

Usage

Install with npm:

npm install css-tree

Basic usage:

import * as csstree from 'css-tree'; // parse CSS to AST const ast = csstree.parse('.example { world: "!" }'); // traverse AST and modify it csstree.walk(ast, (node) => { if (node.type === 'ClassSelector' && node.name === 'example') { node.name = 'hello'; } }); // generate CSS from AST console.log(csstree.generate(ast)); // .hello{world:"!"}

Syntax matching:

// parse CSS to AST as a declaration value const ast = csstree.parse('red 1px solid', { context: 'value' }); // match to syntax of `border` property const matchResult = csstree.lexer.matchProperty('border', ast); // check first value node is a <color> console.log(matchResult.isType(ast.children.first, 'color')); // true // get a type list matched to a node console.log(matchResult.getTrace(ast.children.first)); // [ { type: 'Property', name: 'border' }, // { type: 'Type', name: 'color' }, // { type: 'Type', name: 'named-color' }, // { type: 'Keyword', name: 'red' } ]

Exports

Is it possible to import just a needed part of library like a parser or a walker. That's might useful for loading time or bundle size optimisations.

import * as tokenizer from 'css-tree/tokenizer'; import * as parser from 'css-tree/parser'; import * as walker from 'css-tree/walker'; import * as lexer from 'css-tree/lexer'; import * as definitionSyntax from 'css-tree/definition-syntax'; import * as data from 'css-tree/definition-syntax-data'; import * as dataPatch from 'css-tree/definition-syntax-data-patch'; import * as utils from 'css-tree/utils';

Using in a browser

Bundles are available for use in a browser:

  • dist/csstree.js – minified IIFE with csstree as global
<script src="node_modules/css-tree/dist/csstree.js"></script> <script> csstree.parse('.example { color: green }'); </script>
  • dist/csstree.esm.js – minified ES module
<script type="module"> import { parse } from 'node_modules/css-tree/dist/csstree.esm.js' parse('.example { color: green }'); </script>

One of CDN services like unpkg or jsDelivr can be used. By default (for short path) a ESM version is exposing. For IIFE version a full path to a bundle should be specified:

<!-- ESM --> <script type="module"> import * as csstree from 'https://cdn.jsdelivr.net/npm/css-tree'; import * as csstree from 'https://unpkg.com/css-tree'; </script> <!-- IIFE with an export to global --> <script src="https://cdn.jsdelivr.net/npm/css-tree/dist/csstree.js"></script> <script src="https://unpkg.com/css-tree/dist/csstree.js"></script>

Top level API

API map

License

MIT

Keywords

FAQs

What is css-tree?

A tool set for CSS: fast detailed parser (CSS → AST), walker (AST traversal), generator (AST → CSS) and lexer (validation and matching) based on specs and browser implementations

Is css-tree popular?

The npm package css-tree receives a total of 16,570,632 weekly downloads. As such, css-tree popularity was classified as popular.

Is css-tree well maintained?

We found that css-tree demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 2 open source maintainers collaborating on the project.

Last updated on 14 Aug 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc