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

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

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

/// Metadata of `unused-dependencies`.
pub static META: RuleMeta = RuleMeta::new(
    "unused-dependencies",
    Category::Js,
    Some(Severity::Error),
    Fixability::Unsafe,
    "A package in `dependencies` is never imported, required or run by a script; `optionalDependencies` are not checked.",
);

/// Reports `dependencies` that nothing uses.
///
/// `optionalDependencies` are not checked, as knip does not: they are mostly platform-specific packages that a
/// loader resolves by a computed name, so no source names them. In strict mode the required (not optional)
/// `peerDependencies` are checked too, which knip's strict mode counts as production dependencies.
pub struct UnusedDependencies;

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

    fn check(&self, analysis: &JsAnalysis<'_>, out: &mut Emitter<'_>) {
        let kinds: &[DependencyKind] = if analysis.strict() {
            &[DependencyKind::Dependencies, DependencyKind::PeerDependencies]
        } else {
            &[DependencyKind::Dependencies]
        };
        report_unused_dependencies(&META, kinds, analysis, out);
    }
}