omena-parser 0.4.0

Green-field cstree parser substrate for the Omena CSS parser stack
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
//! Aggregated parser fact surface.
//!
//! This module re-exports the syntax-derived fact records that are safe for
//! query, bridge, LSP, and transform consumers to share.

mod animations;
mod at_rules;
mod css_modules;
mod emission_selectors;
mod icss;
mod sass;
mod selectors;
mod variables;

use cstree::syntax::SyntaxNode;
use omena_syntax::{StyleDialect, SyntaxKind};

use crate::{DialectExtension, ParseResult, Parser, Token, tokenize};

pub(crate) use animations::collect_animation_facts_from_cst;
pub use animations::{ParsedAnimationFact, ParsedAnimationFactKind};
pub use at_rules::ParsedAtRuleFact;
pub(crate) use at_rules::collect_at_rule_facts_from_cst;
pub use css_modules::{
    ParsedCssModuleComposesEdgeFact, ParsedCssModuleComposesEdgeKind, ParsedCssModuleComposesFact,
    ParsedCssModuleComposesFactKind, ParsedCssModuleValueDefinitionEdgeFact,
    ParsedCssModuleValueFact, ParsedCssModuleValueFactKind, ParsedCssModuleValueImportEdgeFact,
};
pub(crate) use css_modules::{
    collect_css_module_composes_edge_facts_from_cst, collect_css_module_composes_facts_from_cst,
    collect_css_module_value_definition_edge_facts_from_cst,
    collect_css_module_value_definition_edge_names, collect_css_module_value_facts_from_cst,
    collect_css_module_value_import_edge_facts_from_cst,
    css_module_value_reference_token_can_be_name, css_module_value_source_name,
    css_module_value_statement_end, declaration_colon_index,
};
pub use emission_selectors::{
    ParsedEmissionSelectorFactKindV0, ParsedEmissionSelectorFactV0, ParsedEmissionSelectorFactsV0,
    collect_emission_selector_facts_from_cst,
};
pub use icss::{
    ParsedIcssExportEdgeFact, ParsedIcssFact, ParsedIcssFactKind, ParsedIcssImportEdgeFact,
    collect_icss_export_values_from_cst,
};
pub(crate) use icss::{
    collect_icss_export_edge_facts_from_cst, collect_icss_facts_from_cst,
    collect_icss_import_edge_facts_from_cst,
};
pub use sass::{
    ParsedExtendTargetFact, ParsedExtendTargetFactKind, ParsedSassCallableParameterFact,
    ParsedSassCallableSignatureFact, ParsedSassIncludeFact, ParsedSassModuleEdgeFact,
    ParsedSassModuleEdgeFactKind, ParsedSassPlaceholderDefinitionFact, ParsedSassSymbolFact,
    ParsedSassSymbolFactKind,
};
pub(crate) use sass::{
    collect_extend_target_facts_from_cst, collect_sass_include_facts_from_cst,
    collect_sass_module_edge_facts_from_cst, collect_sass_placeholder_definition_facts_from_cst,
    collect_sass_symbol_facts_from_cst,
};
pub use selectors::{ParsedSelectorFact, ParsedSelectorFactKind};
pub(crate) use selectors::{
    SelectorBranch, collect_class_selector_names_from_header, collect_selector_facts_from_cst,
    css_module_block_scope_marker_in_header, css_module_header_is_global_only,
    resolve_selector_header, split_selector_groups,
};
pub use variables::{ParsedVariableFact, ParsedVariableFactKind};
pub(crate) use variables::{collect_variable_facts_from_cst, scss_variable_token_is_declaration};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParsedStyleFacts {
    pub product: &'static str,
    pub dialect: StyleDialect,
    pub selector_count: usize,
    pub selectors: Vec<ParsedSelectorFact>,
    pub variable_count: usize,
    pub variables: Vec<ParsedVariableFact>,
    pub sass_symbol_count: usize,
    pub sass_symbols: Vec<ParsedSassSymbolFact>,
    pub sass_include_count: usize,
    pub sass_includes: Vec<ParsedSassIncludeFact>,
    pub sass_module_edge_count: usize,
    pub sass_module_edges: Vec<ParsedSassModuleEdgeFact>,
    pub sass_placeholder_definition_count: usize,
    pub sass_placeholder_definitions: Vec<ParsedSassPlaceholderDefinitionFact>,
    pub extend_target_count: usize,
    pub extend_targets: Vec<ParsedExtendTargetFact>,
    pub animation_count: usize,
    pub animations: Vec<ParsedAnimationFact>,
    pub css_module_value_count: usize,
    pub css_module_values: Vec<ParsedCssModuleValueFact>,
    pub css_module_value_import_edge_count: usize,
    pub css_module_value_import_edges: Vec<ParsedCssModuleValueImportEdgeFact>,
    pub css_module_value_definition_edge_count: usize,
    pub css_module_value_definition_edges: Vec<ParsedCssModuleValueDefinitionEdgeFact>,
    pub css_module_composes_count: usize,
    pub css_module_composes: Vec<ParsedCssModuleComposesFact>,
    pub css_module_composes_edge_count: usize,
    pub css_module_composes_edges: Vec<ParsedCssModuleComposesEdgeFact>,
    pub icss_count: usize,
    pub icss: Vec<ParsedIcssFact>,
    pub icss_import_edge_count: usize,
    pub icss_import_edges: Vec<ParsedIcssImportEdgeFact>,
    pub icss_export_edge_count: usize,
    pub icss_export_edges: Vec<ParsedIcssExportEdgeFact>,
    pub at_rule_count: usize,
    pub at_rules: Vec<ParsedAtRuleFact>,
    pub error_count: usize,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct ParsedStyleFactCollectionV0 {
    pub facts: ParsedStyleFacts,
    pub emission_selectors: ParsedEmissionSelectorFactsV0,
}

struct ProductFacts(ParsedStyleFacts);

impl From<ParsedStyleFacts> for ProductFacts {
    fn from(facts: ParsedStyleFacts) -> Self {
        let ParsedStyleFacts {
            product,
            dialect,
            selector_count,
            selectors,
            variable_count,
            variables,
            sass_symbol_count,
            sass_symbols,
            sass_include_count: _,
            sass_includes: _,
            sass_module_edge_count,
            sass_module_edges,
            sass_placeholder_definition_count,
            sass_placeholder_definitions,
            extend_target_count: _,
            extend_targets: _,
            animation_count,
            animations,
            css_module_value_count,
            css_module_values,
            css_module_value_import_edge_count,
            css_module_value_import_edges,
            css_module_value_definition_edge_count,
            css_module_value_definition_edges,
            css_module_composes_count,
            css_module_composes,
            css_module_composes_edge_count,
            css_module_composes_edges,
            icss_count: _,
            icss: _,
            icss_import_edge_count: _,
            icss_import_edges: _,
            icss_export_edge_count: _,
            icss_export_edges: _,
            at_rule_count: _,
            at_rules: _,
            error_count,
        } = facts;
        let include_sass_declarations = matches!(dialect, StyleDialect::Scss | StyleDialect::Sass);
        let (
            sass_symbol_count,
            sass_symbols,
            sass_module_edge_count,
            sass_module_edges,
            sass_placeholder_definition_count,
            sass_placeholder_definitions,
        ) = if include_sass_declarations {
            (
                sass_symbol_count,
                sass_symbols,
                sass_module_edge_count,
                sass_module_edges,
                sass_placeholder_definition_count,
                sass_placeholder_definitions,
            )
        } else {
            (0, Vec::new(), 0, Vec::new(), 0, Vec::new())
        };

        Self(ParsedStyleFacts {
            product,
            dialect,
            selector_count,
            selectors,
            variable_count,
            variables,
            sass_symbol_count,
            sass_symbols,
            sass_include_count: 0,
            sass_includes: Vec::new(),
            sass_module_edge_count,
            sass_module_edges,
            sass_placeholder_definition_count,
            sass_placeholder_definitions,
            extend_target_count: 0,
            extend_targets: Vec::new(),
            animation_count,
            animations,
            css_module_value_count,
            css_module_values,
            css_module_value_import_edge_count,
            css_module_value_import_edges,
            css_module_value_definition_edge_count,
            css_module_value_definition_edges,
            css_module_composes_count,
            css_module_composes,
            css_module_composes_edge_count,
            css_module_composes_edges,
            icss_count: 0,
            icss: Vec::new(),
            icss_import_edge_count: 0,
            icss_import_edges: Vec::new(),
            icss_export_edge_count: 0,
            icss_export_edges: Vec::new(),
            at_rule_count: 0,
            at_rules: Vec::new(),
            error_count,
        })
    }
}

impl From<ProductFacts> for ParsedStyleFacts {
    fn from(facts: ProductFacts) -> Self {
        facts.0
    }
}

pub fn collect_style_facts_with_extension(
    text: &str,
    extension: &impl DialectExtension,
) -> ParsedStyleFacts {
    let parsed = parse_style_fact_source(text, extension);
    facts_from_cst(text, &parsed)
}

pub fn collect_style_fact_collection_with_extension(
    text: &str,
    extension: &impl DialectExtension,
) -> ParsedStyleFactCollectionV0 {
    let parsed = parse_style_fact_source(text, extension);
    ParsedStyleFactCollectionV0 {
        facts: facts_from_cst(text, &parsed),
        emission_selectors: collect_emission_selector_facts_from_cst(text, &parsed),
    }
}

fn parse_style_fact_source(text: &str, extension: &impl DialectExtension) -> ParseResult {
    let (tokens, lex_errors) = tokenize(text, extension);
    let token_count = tokens.len();
    let mut parser = Parser::new(tokens.clone(), lex_errors, extension.dialect());
    crate::record_omena_parser_parse_materialization(token_count);
    let (green, interner) = parser.parse();
    let errors = parser.into_errors();
    ParseResult::new(green, interner, errors, token_count, extension.dialect())
}

pub fn facts_from_cst(text: &str, parsed: &ParseResult) -> ParsedStyleFacts {
    let selectors = collect_selector_facts_from_cst(text, parsed);
    let variables = collect_variable_facts_from_cst(text, parsed);
    let sass_symbols = collect_sass_symbol_facts_from_cst(text, parsed);
    let sass_includes = collect_sass_include_facts_from_cst(text, parsed);
    let sass_module_edges = collect_sass_module_edge_facts_from_cst(text, parsed);
    let has_placeholder_definition = selectors
        .iter()
        .any(|selector| selector.kind == ParsedSelectorFactKind::Placeholder);
    let sass_placeholder_definitions = if has_placeholder_definition {
        collect_sass_placeholder_definition_facts_from_cst(text, parsed)
    } else {
        Vec::new()
    };
    let extend_targets = collect_extend_target_facts_from_cst(text, parsed);
    let animations = collect_animation_facts_from_cst(text, parsed);
    let css_module_values = collect_css_module_value_facts_from_cst(text, parsed);
    let css_module_value_import_edges =
        collect_css_module_value_import_edge_facts_from_cst(text, parsed);
    let css_module_value_definition_edges =
        collect_css_module_value_definition_edge_facts_from_cst(text, parsed);
    let css_module_composes = collect_css_module_composes_facts_from_cst(text, parsed);
    let css_module_composes_edges = collect_css_module_composes_edge_facts_from_cst(text, parsed);
    let icss = collect_icss_facts_from_cst(text, parsed);
    let icss_import_edges = collect_icss_import_edge_facts_from_cst(text, parsed);
    let icss_export_edges = collect_icss_export_edge_facts_from_cst(text, parsed);
    let at_rules = collect_at_rule_facts_from_cst(text, parsed);

    ParsedStyleFacts {
        product: "omena-parser.style-facts",
        dialect: parsed.dialect(),
        selector_count: selectors.len(),
        selectors,
        variable_count: variables.len(),
        variables,
        sass_symbol_count: sass_symbols.len(),
        sass_symbols,
        sass_include_count: sass_includes.len(),
        sass_includes,
        sass_module_edge_count: sass_module_edges.len(),
        sass_module_edges,
        sass_placeholder_definition_count: sass_placeholder_definitions.len(),
        sass_placeholder_definitions,
        extend_target_count: extend_targets.len(),
        extend_targets,
        animation_count: animations.len(),
        animations,
        css_module_value_count: css_module_values.len(),
        css_module_values,
        css_module_value_import_edge_count: css_module_value_import_edges.len(),
        css_module_value_import_edges,
        css_module_value_definition_edge_count: css_module_value_definition_edges.len(),
        css_module_value_definition_edges,
        css_module_composes_count: css_module_composes.len(),
        css_module_composes,
        css_module_composes_edge_count: css_module_composes_edges.len(),
        css_module_composes_edges,
        icss_count: icss.len(),
        icss,
        icss_import_edge_count: icss_import_edges.len(),
        icss_import_edges,
        icss_export_edge_count: icss_export_edges.len(),
        icss_export_edges,
        at_rule_count: at_rules.len(),
        at_rules,
        error_count: parsed.errors().len(),
    }
}

pub(crate) fn product_facts_from_cst(text: &str, parsed: &ParseResult) -> ParsedStyleFacts {
    ProductFacts::from(facts_from_cst(text, parsed)).into()
}

#[cfg(test)]
mod product_facts_authority_tests;

pub(crate) fn tokens_from_syntax_node<'text>(
    text: &'text str,
    parsed: &ParseResult,
    node: &SyntaxNode<SyntaxKind>,
) -> Vec<Token<'text>> {
    let node_range = node.text_range();
    let tokens = parsed.syntax_token_views();
    let start_index = tokens.partition_point(|token| token.range.start() < node_range.start());
    let end_index = tokens[start_index..]
        .partition_point(|token| token.range.start() < node_range.end())
        + start_index;
    tokens[start_index..end_index]
        .iter()
        .filter(|token| token.range.end() <= node_range.end())
        .map(|token| {
            let range = token.range;
            let start = u32::from(range.start()) as usize;
            let end = u32::from(range.end()) as usize;
            Token {
                kind: token.kind,
                text: text.get(start..end).unwrap_or_default(),
                range,
            }
        })
        .collect()
}

pub(crate) fn syntax_node_is_top_level(node: &SyntaxNode<SyntaxKind>) -> bool {
    node.parent().is_some_and(|parent| {
        matches!(
            parent.kind(),
            SyntaxKind::Stylesheet | SyntaxKind::ScssStylesheet | SyntaxKind::LessStylesheet
        )
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{StyleDialect, parse};

    fn tokens_from_syntax_node_linear<'text>(
        text: &'text str,
        parsed: &ParseResult,
        node: &SyntaxNode<SyntaxKind>,
    ) -> Vec<Token<'text>> {
        let node_range = node.text_range();
        parsed
            .syntax_token_views()
            .iter()
            .filter(|token| token.range.start() >= node_range.start())
            .filter(|token| token.range.end() <= node_range.end())
            .map(|token| {
                let range = token.range;
                let start = u32::from(range.start()) as usize;
                let end = u32::from(range.end()) as usize;
                Token {
                    kind: token.kind,
                    text: text.get(start..end).unwrap_or_default(),
                    range,
                }
            })
            .collect()
    }

    #[test]
    fn tokens_from_syntax_node_matches_linear_scan_order() {
        let text = r#"@use "./tokens" as t;
:export { exported: local; }
.button, :global(.card) {
  --gap: 1rem;
  color: var(--brand);
  &__icon { composes: icon from "./icons.module.css"; }
}
@media (width >= 1px) {
  .button--primary { color: t.$brand; }
}"#;
        let parsed = parse(text, StyleDialect::Scss);
        let syntax = parsed.syntax();

        for node in syntax.descendants() {
            assert_eq!(
                tokens_from_syntax_node(text, &parsed, node),
                tokens_from_syntax_node_linear(text, &parsed, node),
                "token slice drift for {:?} at {:?}",
                node.kind(),
                node.text_range()
            );
        }
    }
}