skif-js 0.2.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

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

use super::JsRule;
use super::support::{is_fixture, module_location};
use crate::analysis::JsAnalysis;
use crate::graph::Target;

/// Metadata of `unresolved-imports`.
pub static META: RuleMeta = RuleMeta::new(
    "unresolved-imports",
    Category::Js,
    Some(Severity::Error),
    Fixability::None,
    "An import specifier does not resolve to a file or a package.",
);

/// Reports relative, aliased and `#` specifiers that point nowhere.
pub struct UnresolvedImports;

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

    fn check(&self, analysis: &JsAnalysis<'_>, out: &mut Emitter<'_>) {
        for module in analysis.graph.modules() {
            if module.ignored || is_fixture(module) || analysis.is_skipped(module.owner) {
                continue;
            }
            let package = analysis.workspace.package(module.owner);
            for resolved in module
                .imports
                .iter()
                .filter(|resolved| resolved.target == Target::Unresolved)
            {
                let Some(import) = module.info.imports.get(resolved.import) else {
                    continue;
                };
                if analysis.ignores_unresolved(module.owner, &import.specifier) {
                    continue;
                }
                let mut builder = diagnostic(
                    &META,
                    format!("cannot resolve `{}`", import.specifier),
                    module_location(module, Some(import.span)),
                )
                .help("check the path, the `tsconfig` paths, the bundler aliases and the package `exports`");
                if let Some(package) = package {
                    builder = builder.package(package.display_name());
                }
                out.emit(builder.build());
            }
        }
    }
}