Skip to content

Commit cece4df

Browse files
mdevilsmdevils
committed
feat: upgrade API in order to reflect upcoming complexity in CSS selectors
BREAKING CHANGE: API is backwards incompatible
1 parent f079d98 commit cece4df

16 files changed

+624
-405
lines changed

‎README.md

+63-58
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ css-selector-parser
77
* Covered with tests.
88
* Documented.
99
* Supported CSS selector standards:
10-
* `css1`: https://www.w3.org/TR/CSS1/
11-
* `css2`: https://www.w3.org/TR/CSS2/
12-
* `css3`/`selectors-3`: https://www.w3.org/TR/selectors-3/
13-
* `selectors-4`: https://www.w3.org/TR/selectors-4/
14-
* `latest`: refers to `selectors-4`
15-
* `progressive`: `latest` + accepts unknown psudo-classes, psudo-elements and attribute case sensitivity modifiers
10+
* `css1`: https://www.w3.org/TR/CSS1/
11+
* `css2`: https://www.w3.org/TR/CSS2/
12+
* `css3`/`selectors-3`: https://www.w3.org/TR/selectors-3/
13+
* `selectors-4`: https://www.w3.org/TR/selectors-4/
14+
* `latest`: refers to `selectors-4`
15+
* `progressive`: `latest` + accepts unknown psudo-classes, psudo-elements and attribute case sensitivity modifiers
1616

1717
**Important:** [Migrating from 1.x](CHANGELOG.md#220).
1818

19+
Latest releases: [Changelog](CHANGELOG.md).
20+
1921
Installation
2022
------------
2123

@@ -41,48 +43,53 @@ Produces:
4143

4244
```javascript
4345
({
44-
type: 'Selector',
45-
rules: [
46-
{
47-
type: 'Rule',
48-
tag: { type: 'TagName', name: 'a' },
49-
attributes: [
46+
type: 'Selector',
47+
rules: [
5048
{
51-
type: 'Attribute',
52-
name: 'href',
53-
operator: '^=',
54-
value: { type: 'String', value: '/' }
55-
}
56-
]
57-
},
58-
{
59-
type: 'Rule',
60-
classNames: [ 'container' ],
61-
pseudoClasses: [
49+
type: 'Rule',
50+
items: [
51+
{ type: 'TagName', name: 'a' },
52+
{
53+
type: 'Attribute',
54+
name: 'href',
55+
operator: '^=',
56+
value: { type: 'String', value: '/' }
57+
}
58+
]
59+
},
6260
{
63-
type: 'PseudoClass',
64-
name: 'has',
65-
argument: {
66-
type: 'Selector',
67-
rules: [ { type: 'Rule', tag: { type: 'TagName', name: 'nav' } } ]
68-
}
61+
type: 'Rule',
62+
items: [
63+
{ type: 'ClassName', name: 'container' },
64+
{
65+
type: 'PseudoClass',
66+
name: 'has',
67+
argument: {
68+
type: 'Selector',
69+
rules: [
70+
{
71+
type: 'Rule',
72+
items: [ { type: 'TagName', name: 'nav' } ]
73+
}
74+
]
75+
}
76+
}
77+
],
78+
nestedRule: {
79+
type: 'Rule',
80+
items: [
81+
{ type: 'TagName', name: 'a' },
82+
{ type: 'Attribute', name: 'href' },
83+
{
84+
type: 'PseudoClass',
85+
name: 'nth-child',
86+
argument: { type: 'Formula', a: 0, b: 2 }
87+
}
88+
],
89+
combinator: '>'
90+
}
6991
}
70-
],
71-
nestedRule: {
72-
type: 'Rule',
73-
combinator: '>',
74-
tag: { type: 'TagName', name: 'a' },
75-
attributes: [ { type: 'Attribute', name: 'href' } ],
76-
pseudoClasses: [
77-
{
78-
type: 'PseudoClass',
79-
name: 'nth-child',
80-
argument: { type: 'Formula', a: 0, b: 2 }
81-
}
82-
]
83-
}
84-
}
85-
]
92+
]
8693
})
8794
```
8895

@@ -94,34 +101,32 @@ import {ast, render} from 'css-selector-parser';
94101
const selector = ast.selector({
95102
rules: [
96103
ast.rule({
97-
tag: ast.tagName({name: 'a'}),
98-
attributes: [
104+
items: [
105+
ast.tagName({name: 'a'}),
99106
ast.attribute({name: 'href', operator: '^=', value: ast.string({value: '/'})})
100107
]
101108
}),
102109
ast.rule({
103-
classNames: ['container'],
104-
pseudoClasses: [
110+
items: [
111+
ast.className({name: 'container'}),
105112
ast.pseudoClass({
106113
name: 'has',
107114
argument: ast.selector({
108-
rules: [
109-
ast.rule({tag: ast.tagName({name: 'nav'})})
110-
]
115+
rules: [ast.rule({items: [ast.tagName({name: 'nav'})]})]
111116
})
112117
})
113118
],
114119
nestedRule: ast.rule({
115120
combinator: '>',
116-
tag: ast.tagName({name: 'a'}),
117-
attributes: [ast.attribute({name: 'href'})],
118-
pseudoClasses: [
121+
items: [
122+
ast.tagName({name: 'a'}),
123+
ast.attribute({name: 'href'}),
119124
ast.pseudoClass({
120125
name: 'nth-child',
121126
argument: ast.formula({a: 0, b: 2})
122-
})
123-
],
124-
pseudoElement: 'before'
127+
}),
128+
ast.pseudoElement({name: 'before'})
129+
]
125130
})
126131
})
127132
]

‎docs/interfaces/AstClassName.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[css-selector-parser](../../README.md) / [Exports](../modules.md) / AstClassName
2+
3+
# Interface: AstClassName
4+
5+
Class name condition. Matches by class attribute value.
6+
Generated by [ast.className](AstFactory.md#classname).
7+
https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors
8+
9+
**`Example`**
10+
11+
```ts
12+
".user"
13+
```
14+
15+
## Table of contents
16+
17+
### Properties
18+
19+
- [name](AstClassName.md#name)
20+
- [type](AstClassName.md#type)
21+
22+
## Properties
23+
24+
### name
25+
26+
• **name**: `string`
27+
28+
ID name. I.e. `.user` -> `"user"`.
29+
30+
___
31+
32+
### type
33+
34+
• **type**: ``"ClassName"``

0 commit comments

Comments
 (0)