skif-js 0.4.0

JavaScript and TypeScript module graph and dependency rules for skif, built on oxc.
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

use std::path::Path;

use skif_core::{Category, Fixability, RuleMeta, Severity, diagnostic, slash};
use skif_lint::Emitter;

use super::JsRule;
use super::support::module_location;
use crate::analysis::JsAnalysis;

/// Metadata of `unparseable-files`. The parser could not recover from a syntax error, so what the file imports and
/// exports is unknown and the other JS rules treat it as empty.
pub static META: RuleMeta = RuleMeta::new(
    "unparseable-files",
    Category::Js,
    Some(Severity::Warning),
    Fixability::None,
    "A file reachable from an entry file has a syntax error the parser could not recover from.",
);

/// Reports files in the module graph whose imports and exports could not be read.
pub struct UnparseableFiles;

/// The message of a file the parser gave up on, with `/` separators on every platform.
fn unparseable_message(path: &Path, error: &str) -> String {
    format!("`{}` could not be parsed: {error}", slash(path))
}

impl JsRule for UnparseableFiles {
    fn meta(&self) -> &'static RuleMeta {
        &META
    }

    fn check(&self, analysis: &JsAnalysis<'_>, out: &mut Emitter<'_>) {
        for module in analysis.graph.modules() {
            let Some(error) = &module.parse_error else { continue };
            if module.ignored || analysis.is_skipped(module.owner) {
                continue;
            }
            let span = module.info.parse_diagnostics.first().map(|issue| issue.span);
            let mut builder = diagnostic(
                &META,
                unparseable_message(&module.path, error),
                module_location(module, span),
            )
            .help("fix the syntax error, or add the file to `ignore`; its imports and exports are not analysed");
            if let Some(package) = analysis.workspace.package(module.owner) {
                builder = builder.package(package.display_name());
            }
            out.emit(builder.build());
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn the_message_names_the_file_with_forward_slashes() {
        let path = Path::new("packages").join("a").join("broken.ts");
        assert_eq!(
            unparseable_message(&path, "unexpected token"),
            "`packages/a/broken.ts` could not be parsed: unexpected token"
        );
    }
}