3.0.0 • Published 5 years ago

scalpel v3.0.0

Weekly downloads
920
License
BSD-3-Clause
Repository
github
Last release
5 years ago

scalpel

Travis build status NPM version Canonical Code Style Twitter Follow

A CSS selector parser.

It parses any valid CSS3 selector into tokens. Try it!

Found a selector that cannot be parsed? Raise an issue.

This parser is implemented using Earley parser algorithm. Read about Writing a CSS selector parser in under 120 LoC.

Note:

This parser could be extended to support the entire CSS grammar. I don't have such a use case. However, should you want to add new grammar, raise an issue.

Usage

import {
  createGenerator,
  createParser
} from 'scalpel';

const generator = createGenerator();
const parser = createParser();

const tokens: Array<SelectorTokenType | CombinatorTokenType> = parser.parse('.foo.bar');

// [
//   {
//     type: 'selector',
//     body: [
//       {
//         type: 'classSelector',
//         name: 'foo'
//       },
//       {
//         type: 'classSelector',
//         name: 'bar'
//       }
//     ]
//   }
// ]

const selector: string = generator.generate(token);

// .foo.bar

Note:

For programmatic type definitions, refer to ./src/types.js.

Token types

TypeDescriptionExample
adjacentSiblingCombinatorAn adjacent sibling combinator..baz0 + .baz1
attributePresenceSelectorAn attribute presence selector.[qux]
attributeValueSelectorAn attribute value selector.[qux=val], [qux~=val]
childCombinatorA child combinator..baz0 > .baz1
classSelectorA class selector..baz
descendantCombinatorA descendant combinator..baz0 .baz1
generalSiblingCombinatorA general sibling combinator..baz0 ~ .baz1
idSelectorAn ID selector#bar
pseudoClassSelectorA pseudo-class selector.:corge, :corge(), :corge(val0, 'val1', "val2")
pseudoElementSelectorA pseudo-element selector.::grault
typeSelectorA type selector.foo
universalSelectorA universal selector.*

Fields

Tokens have fields that describe additional information about the token. Fields are token type specific.

adjacentSiblingCombinator

NameDescriptionExample
typeName of the token type."adjacentSiblingCombinator"

attributePresenceSelector

NameDescriptionExample
nameName of the element attribute."qux" in [qux]
typeName of the token type."attributePresenceSelector"

attributeValueSelector

NameDescriptionExample
nameName of the element attribute."qux" in [qux]
operatorOperator of the expression."*=" in [qux*=val]
typeName of the token type."attributeValueSelector"
valueValue of the expression."val" in [qux=val]

childCombinator

NameDescriptionExample
typeName of the token type."childCombinator"

classSelector

NameDescriptionExample
nameClass name."baz" in .baz[qux]
typeName of the token type."classSelector"

descendantCombinator

NameDescriptionExample
typeName of the token type."descendantCombinator"

generalSiblingCombinator

NameDescriptionExample
typeName of the token type."generalSiblingCombinator"

idSelector

NameDescriptionExample
nameName of the ID."bar" in #bar:corge()
typeName of the token type."idSelector"

pseudoClassSelector

NameDescriptionExample
nameName of the pseudo-class."corge" in #bar:corge()
parametersArray of parameter values."var0", "var1" and "var2" in :corge(var0, 'var1', "var2")
typeName of the token type."pseudoClassSelector"

pseudoElementSelector

NameDescriptionExample
nameName of the pseudo-element."grault" in #bar::grault
typeName of the token type."pseudoElementSelector"

typeSelector

NameDescriptionExample
nameName of the node."foo" in foo#bar.baz
typeName of the token type."typeSelector"

universalSelector

NameDescriptionExample
typeName of the token type."universalSelector"

Development

git pull git@github.com:gajus/scalpel.git
cd ./scalpel
npm install
npm run test

The parser grammar is in the ./src/grammar.ne file. After making changes to the parser grammar, you need to compile the parser using npm run compile-grammar command.

3.0.0

5 years ago

2.1.0

7 years ago

2.0.0

7 years ago

0.0.4

11 years ago

0.0.3

12 years ago

0.0.2

12 years ago

0.0.1

12 years ago