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

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

use super::JsRule;
use super::support::{module_location, unresolved_imports};
use crate::analysis::JsAnalysis;

/// Metadata of `stale-mocks`. An error, as the same findings were under `unresolved-imports`: the test runners throw
/// on most of these calls (ADR 0019).
pub static META: RuleMeta = RuleMeta::new(
    "stale-mocks",
    Category::Js,
    Some(Severity::Error),
    Fixability::None,
    "A test-runner mock names a relative or aliased module that does not exist.",
);

/// Reports `vi.mock`, `vi.doMock`, `vi.unmock`, `vi.importActual`, `jest.mock`, `jest.doMock`, `jest.requireActual`
/// and the other calls of the test runners that name a module ([`MockCall`]), including Vitest's
/// `vi.mock(import("x"))`, when the relative, aliased or `#` specifier resolves to nothing. The specifier is resolved
/// as an import is, query (`?react`, `?url`, `?raw`) dropped. A bare package name that resolves to nothing is taken
/// for a dependency and is not reported here, nor as unlisted (#16).
pub struct StaleMocks;

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

    fn check(&self, analysis: &JsAnalysis<'_>, out: &mut Emitter<'_>) {
        for (module, import) in unresolved_imports(analysis, true) {
            let call = import.call.map_or("mock", MockCall::as_str);
            let mut builder = diagnostic(
                &META,
                format!("`{call}('{}')` names a module that does not exist", import.specifier),
                module_location(module, Some(import.span)),
            )
            .help("remove the call, or point it at the module's new path");
            if let Some(package) = analysis.workspace.package(module.owner) {
                builder = builder.package(package.display_name());
            }
            out.emit(builder.build());
        }
    }
}