fallow_extract/
css.rs

1//! CSS/SCSS file parsing and CSS Module class name extraction.
2//!
3//! Handles `@import`, `@use`, `@forward`, `@apply`, `@tailwind` directives,
4//! and extracts class names as named exports from `.module.css`/`.module.scss` files.
5
6use std::path::Path;
7use std::sync::LazyLock;
8
9use oxc_span::Span;
10
11use crate::{ExportInfo, ExportName, ImportInfo, ImportedName, ModuleInfo};
12use fallow_types::discover::FileId;
13
14/// Regex to extract CSS @import sources.
15/// Matches: @import "path"; @import 'path'; @import url("path"); @import url('path'); @import url(path);
16static CSS_IMPORT_RE: LazyLock<regex::Regex> = LazyLock::new(|| {
17    regex::Regex::new(r#"@import\s+(?:url\(\s*(?:["']([^"']+)["']|([^)]+))\s*\)|["']([^"']+)["'])"#)
18        .expect("valid regex")
19});
20
21/// Regex to extract SCSS @use and @forward sources.
22/// Matches: @use "path"; @use 'path'; @forward "path"; @forward 'path';
23static SCSS_USE_RE: LazyLock<regex::Regex> = LazyLock::new(|| {
24    regex::Regex::new(r#"@(?:use|forward)\s+["']([^"']+)["']"#).expect("valid regex")
25});
26
27/// Regex to extract @apply class references.
28/// Matches: @apply class1 class2 class3;
29static CSS_APPLY_RE: LazyLock<regex::Regex> =
30    LazyLock::new(|| regex::Regex::new(r"@apply\s+[^;}\n]+").expect("valid regex"));
31
32/// Regex to extract @tailwind directives.
33/// Matches: @tailwind base; @tailwind components; @tailwind utilities;
34static CSS_TAILWIND_RE: LazyLock<regex::Regex> =
35    LazyLock::new(|| regex::Regex::new(r"@tailwind\s+\w+").expect("valid regex"));
36
37/// Regex to match CSS block comments (`/* ... */`) for stripping before extraction.
38static CSS_COMMENT_RE: LazyLock<regex::Regex> =
39    LazyLock::new(|| regex::Regex::new(r"(?s)/\*.*?\*/").expect("valid regex"));
40
41/// Regex to match SCSS single-line comments (`// ...`) for stripping before extraction.
42static SCSS_LINE_COMMENT_RE: LazyLock<regex::Regex> =
43    LazyLock::new(|| regex::Regex::new(r"//[^\n]*").expect("valid regex"));
44
45/// Regex to extract CSS class names from selectors.
46/// Matches `.className` in selectors. Applied after stripping comments, strings, and URLs.
47static CSS_CLASS_RE: LazyLock<regex::Regex> =
48    LazyLock::new(|| regex::Regex::new(r"\.([a-zA-Z_][a-zA-Z0-9_-]*)").expect("valid regex"));
49
50/// Regex to strip quoted strings and `url(...)` content from CSS before class extraction.
51/// Prevents false positives from `content: ".foo"` and `url(./path/file.ext)`.
52static CSS_NON_SELECTOR_RE: LazyLock<regex::Regex> = LazyLock::new(|| {
53    regex::Regex::new(r#"(?s)"[^"]*"|'[^']*'|url\([^)]*\)"#).expect("valid regex")
54});
55
56pub(crate) fn is_css_file(path: &Path) -> bool {
57    path.extension()
58        .and_then(|e| e.to_str())
59        .is_some_and(|ext| ext == "css" || ext == "scss")
60}
61
62fn is_css_module_file(path: &Path) -> bool {
63    is_css_file(path)
64        && path
65            .file_stem()
66            .and_then(|s| s.to_str())
67            .is_some_and(|stem| stem.ends_with(".module"))
68}
69
70/// Returns true if a CSS import source is a remote URL or data URI that should be skipped.
71fn is_css_url_import(source: &str) -> bool {
72    source.starts_with("http://") || source.starts_with("https://") || source.starts_with("data:")
73}
74
75/// Normalize a CSS/SCSS import path to use `./` prefix for relative paths.
76/// CSS/SCSS resolve imports without `./` prefix as relative by default,
77/// unlike JS where unprefixed specifiers are bare (npm) specifiers.
78/// Only applies to paths with CSS/SCSS extensions — extensionless imports
79/// like `@import "tailwindcss"` are actual npm package imports.
80fn normalize_css_import_path(path: String) -> String {
81    if path.starts_with('.') || path.starts_with('/') || path.contains("://") {
82        return path;
83    }
84    // Paths with CSS/SCSS extensions are relative file imports
85    let ext = std::path::Path::new(&path)
86        .extension()
87        .and_then(|e| e.to_str());
88    match ext {
89        Some(e)
90            if e.eq_ignore_ascii_case("css")
91                || e.eq_ignore_ascii_case("scss")
92                || e.eq_ignore_ascii_case("sass")
93                || e.eq_ignore_ascii_case("less") =>
94        {
95            format!("./{path}")
96        }
97        _ => path,
98    }
99}
100
101/// Strip comments from CSS/SCSS source to avoid matching directives inside comments.
102fn strip_css_comments(source: &str, is_scss: bool) -> String {
103    let stripped = CSS_COMMENT_RE.replace_all(source, "");
104    if is_scss {
105        SCSS_LINE_COMMENT_RE.replace_all(&stripped, "").into_owned()
106    } else {
107        stripped.into_owned()
108    }
109}
110
111/// Extract class names from a CSS module file as named exports.
112pub fn extract_css_module_exports(source: &str) -> Vec<ExportInfo> {
113    let cleaned = CSS_NON_SELECTOR_RE.replace_all(source, "");
114    let mut seen = rustc_hash::FxHashSet::default();
115    let mut exports = Vec::new();
116    for cap in CSS_CLASS_RE.captures_iter(&cleaned) {
117        if let Some(m) = cap.get(1) {
118            let class_name = m.as_str().to_string();
119            if seen.insert(class_name.clone()) {
120                exports.push(ExportInfo {
121                    name: ExportName::Named(class_name),
122                    local_name: None,
123                    is_type_only: false,
124                    is_public: false,
125                    span: Span::default(),
126                    members: Vec::new(),
127                });
128            }
129        }
130    }
131    exports
132}
133
134/// Parse a CSS/SCSS file, extracting @import, @use, @forward, @apply, and @tailwind directives.
135pub(crate) fn parse_css_to_module(
136    file_id: FileId,
137    path: &Path,
138    source: &str,
139    content_hash: u64,
140) -> ModuleInfo {
141    let suppressions = crate::suppress::parse_suppressions_from_source(source);
142    let is_scss = path
143        .extension()
144        .and_then(|e| e.to_str())
145        .is_some_and(|ext| ext == "scss");
146
147    // Strip comments before matching to avoid false positives from commented-out code.
148    let stripped = strip_css_comments(source, is_scss);
149
150    let mut imports = Vec::new();
151
152    // Extract @import statements
153    for cap in CSS_IMPORT_RE.captures_iter(&stripped) {
154        let source_path = cap
155            .get(1)
156            .or_else(|| cap.get(2))
157            .or_else(|| cap.get(3))
158            .map(|m| m.as_str().trim().to_string());
159        if let Some(src) = source_path
160            && !src.is_empty()
161            && !is_css_url_import(&src)
162        {
163            // CSS/SCSS @import resolves relative paths without ./ prefix,
164            // so normalize to ./ to avoid bare-specifier misclassification
165            let src = normalize_css_import_path(src);
166            imports.push(ImportInfo {
167                source: src,
168                imported_name: ImportedName::SideEffect,
169                local_name: String::new(),
170                is_type_only: false,
171                span: Span::default(),
172                source_span: Span::default(),
173            });
174        }
175    }
176
177    // Extract SCSS @use/@forward statements
178    if is_scss {
179        for cap in SCSS_USE_RE.captures_iter(&stripped) {
180            if let Some(m) = cap.get(1) {
181                imports.push(ImportInfo {
182                    source: normalize_css_import_path(m.as_str().to_string()),
183                    imported_name: ImportedName::SideEffect,
184                    local_name: String::new(),
185                    is_type_only: false,
186                    span: Span::default(),
187                    source_span: Span::default(),
188                });
189            }
190        }
191    }
192
193    // If @apply or @tailwind directives exist, create a synthetic import to tailwindcss
194    // to mark the dependency as used
195    let has_apply = CSS_APPLY_RE.is_match(&stripped);
196    let has_tailwind = CSS_TAILWIND_RE.is_match(&stripped);
197    if has_apply || has_tailwind {
198        imports.push(ImportInfo {
199            source: "tailwindcss".to_string(),
200            imported_name: ImportedName::SideEffect,
201            local_name: String::new(),
202            is_type_only: false,
203            span: Span::default(),
204            source_span: Span::default(),
205        });
206    }
207
208    // For CSS module files, extract class names as named exports
209    let exports = if is_css_module_file(path) {
210        extract_css_module_exports(&stripped)
211    } else {
212        Vec::new()
213    };
214
215    ModuleInfo {
216        file_id,
217        exports,
218        imports,
219        re_exports: Vec::new(),
220        dynamic_imports: Vec::new(),
221        dynamic_import_patterns: Vec::new(),
222        require_calls: Vec::new(),
223        member_accesses: Vec::new(),
224        whole_object_uses: Vec::new(),
225        has_cjs_exports: false,
226        content_hash,
227        suppressions,
228        unused_import_bindings: Vec::new(),
229        line_offsets: fallow_types::extract::compute_line_offsets(source),
230        complexity: Vec::new(),
231    }
232}
233
234#[cfg(test)]
235mod tests {
236    use super::*;
237
238    /// Helper to collect export names as strings from `extract_css_module_exports`.
239    fn export_names(source: &str) -> Vec<String> {
240        extract_css_module_exports(source)
241            .into_iter()
242            .filter_map(|e| match e.name {
243                ExportName::Named(n) => Some(n),
244                _ => None,
245            })
246            .collect()
247    }
248
249    // ── is_css_file ──────────────────────────────────────────────
250
251    #[test]
252    fn is_css_file_css() {
253        assert!(is_css_file(Path::new("styles.css")));
254    }
255
256    #[test]
257    fn is_css_file_scss() {
258        assert!(is_css_file(Path::new("styles.scss")));
259    }
260
261    #[test]
262    fn is_css_file_rejects_js() {
263        assert!(!is_css_file(Path::new("app.js")));
264    }
265
266    #[test]
267    fn is_css_file_rejects_ts() {
268        assert!(!is_css_file(Path::new("app.ts")));
269    }
270
271    #[test]
272    fn is_css_file_rejects_less() {
273        assert!(!is_css_file(Path::new("styles.less")));
274    }
275
276    #[test]
277    fn is_css_file_rejects_no_extension() {
278        assert!(!is_css_file(Path::new("Makefile")));
279    }
280
281    // ── is_css_module_file ───────────────────────────────────────
282
283    #[test]
284    fn is_css_module_file_module_css() {
285        assert!(is_css_module_file(Path::new("Component.module.css")));
286    }
287
288    #[test]
289    fn is_css_module_file_module_scss() {
290        assert!(is_css_module_file(Path::new("Component.module.scss")));
291    }
292
293    #[test]
294    fn is_css_module_file_rejects_plain_css() {
295        assert!(!is_css_module_file(Path::new("styles.css")));
296    }
297
298    #[test]
299    fn is_css_module_file_rejects_plain_scss() {
300        assert!(!is_css_module_file(Path::new("styles.scss")));
301    }
302
303    #[test]
304    fn is_css_module_file_rejects_module_js() {
305        assert!(!is_css_module_file(Path::new("utils.module.js")));
306    }
307
308    // ── extract_css_module_exports: basic class extraction ───────
309
310    #[test]
311    fn extracts_single_class() {
312        let names = export_names(".foo { color: red; }");
313        assert_eq!(names, vec!["foo"]);
314    }
315
316    #[test]
317    fn extracts_multiple_classes() {
318        let names = export_names(".foo { } .bar { }");
319        assert_eq!(names, vec!["foo", "bar"]);
320    }
321
322    #[test]
323    fn extracts_nested_classes() {
324        let names = export_names(".foo .bar { color: red; }");
325        assert!(names.contains(&"foo".to_string()));
326        assert!(names.contains(&"bar".to_string()));
327    }
328
329    #[test]
330    fn extracts_hyphenated_class() {
331        let names = export_names(".my-class { }");
332        assert_eq!(names, vec!["my-class"]);
333    }
334
335    #[test]
336    fn extracts_camel_case_class() {
337        let names = export_names(".myClass { }");
338        assert_eq!(names, vec!["myClass"]);
339    }
340
341    #[test]
342    fn extracts_underscore_class() {
343        let names = export_names("._hidden { } .__wrapper { }");
344        assert!(names.contains(&"_hidden".to_string()));
345        assert!(names.contains(&"__wrapper".to_string()));
346    }
347
348    // ── Pseudo-selectors ─────────────────────────────────────────
349
350    #[test]
351    fn pseudo_selector_hover() {
352        let names = export_names(".foo:hover { color: blue; }");
353        assert_eq!(names, vec!["foo"]);
354    }
355
356    #[test]
357    fn pseudo_selector_focus() {
358        let names = export_names(".input:focus { outline: none; }");
359        assert_eq!(names, vec!["input"]);
360    }
361
362    #[test]
363    fn pseudo_element_before() {
364        let names = export_names(".icon::before { content: ''; }");
365        assert_eq!(names, vec!["icon"]);
366    }
367
368    #[test]
369    fn combined_pseudo_selectors() {
370        let names = export_names(".btn:hover, .btn:active, .btn:focus { }");
371        // "btn" should be deduplicated
372        assert_eq!(names, vec!["btn"]);
373    }
374
375    // ── Media queries ────────────────────────────────────────────
376
377    #[test]
378    fn classes_inside_media_query() {
379        let names = export_names(
380            "@media (max-width: 768px) { .mobile-nav { display: block; } .desktop-nav { display: none; } }",
381        );
382        assert!(names.contains(&"mobile-nav".to_string()));
383        assert!(names.contains(&"desktop-nav".to_string()));
384    }
385
386    // ── Deduplication ────────────────────────────────────────────
387
388    #[test]
389    fn deduplicates_repeated_class() {
390        let names = export_names(".btn { color: red; } .btn { font-size: 14px; }");
391        assert_eq!(names.iter().filter(|n| *n == "btn").count(), 1);
392    }
393
394    // ── Edge cases ───────────────────────────────────────────────
395
396    #[test]
397    fn empty_source() {
398        let names = export_names("");
399        assert!(names.is_empty());
400    }
401
402    #[test]
403    fn no_classes() {
404        let names = export_names("body { margin: 0; } * { box-sizing: border-box; }");
405        assert!(names.is_empty());
406    }
407
408    #[test]
409    fn ignores_classes_in_block_comments() {
410        // Note: extract_css_module_exports itself does NOT strip comments;
411        // comments are stripped in parse_css_to_module before calling it.
412        // But CSS_NON_SELECTOR_RE strips quoted strings. Testing the
413        // strip_css_comments + extract pipeline via the stripped source:
414        let stripped = strip_css_comments("/* .fake { } */ .real { }", false);
415        let names = export_names(&stripped);
416        assert!(!names.contains(&"fake".to_string()));
417        assert!(names.contains(&"real".to_string()));
418    }
419
420    #[test]
421    fn ignores_classes_in_strings() {
422        let names = export_names(r#".real { content: ".fake"; }"#);
423        assert!(names.contains(&"real".to_string()));
424        assert!(!names.contains(&"fake".to_string()));
425    }
426
427    #[test]
428    fn ignores_classes_in_url() {
429        let names = export_names(".real { background: url(./images/hero.png); }");
430        assert!(names.contains(&"real".to_string()));
431        // "png" from "hero.png" should not be extracted
432        assert!(!names.contains(&"png".to_string()));
433    }
434
435    // ── strip_css_comments ───────────────────────────────────────
436
437    #[test]
438    fn strip_css_block_comment() {
439        let result = strip_css_comments("/* removed */ .kept { }", false);
440        assert!(!result.contains("removed"));
441        assert!(result.contains(".kept"));
442    }
443
444    #[test]
445    fn strip_scss_line_comment() {
446        let result = strip_css_comments("// removed\n.kept { }", true);
447        assert!(!result.contains("removed"));
448        assert!(result.contains(".kept"));
449    }
450
451    #[test]
452    fn strip_scss_preserves_css_outside_comments() {
453        let source = "// line comment\n/* block comment */\n.visible { color: red; }";
454        let result = strip_css_comments(source, true);
455        assert!(result.contains(".visible"));
456    }
457
458    // ── is_css_url_import ────────────────────────────────────────
459
460    #[test]
461    fn url_import_http() {
462        assert!(is_css_url_import("http://example.com/style.css"));
463    }
464
465    #[test]
466    fn url_import_https() {
467        assert!(is_css_url_import("https://fonts.googleapis.com/css"));
468    }
469
470    #[test]
471    fn url_import_data() {
472        assert!(is_css_url_import("data:text/css;base64,abc"));
473    }
474
475    #[test]
476    fn url_import_local_not_skipped() {
477        assert!(!is_css_url_import("./local.css"));
478    }
479
480    #[test]
481    fn url_import_bare_specifier_not_skipped() {
482        assert!(!is_css_url_import("tailwindcss"));
483    }
484}
fallow_extract/css.rs

fallow_extract/
css.rs
