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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! The JS rules, one per file.

mod circular_imports;
mod duplicate_exports;
mod members;
mod stale_js_config;
mod stale_mocks;
mod support;
mod unlisted_binaries;
mod unlisted_dependencies;
mod unparseable_files;
mod unresolved_imports;
mod unused_dependencies;
mod unused_dev_dependencies;
mod unused_enum_members;
mod unused_exports;
mod unused_files;
mod unused_namespace_exports;
mod unused_namespace_members;
mod unused_namespace_types;
mod unused_optional_peer_dependencies;
mod unused_subpath_exports;
mod unused_subpath_imports;
mod unused_types;

use skif_core::RuleMeta;
use skif_lint::Emitter;

pub use circular_imports::CircularImports;
pub use duplicate_exports::DuplicateExports;
pub use stale_js_config::StaleJsConfig;
pub use stale_mocks::StaleMocks;
pub use unlisted_binaries::UnlistedBinaries;
pub use unlisted_dependencies::UnlistedDependencies;
pub use unparseable_files::UnparseableFiles;
pub use unresolved_imports::UnresolvedImports;
pub use unused_dependencies::UnusedDependencies;
pub use unused_dev_dependencies::UnusedDevDependencies;
pub use unused_enum_members::UnusedEnumMembers;
pub use unused_exports::UnusedExports;
pub use unused_files::UnusedFiles;
pub use unused_namespace_exports::UnusedNamespaceExports;
pub use unused_namespace_members::UnusedNamespaceMembers;
pub use unused_namespace_types::UnusedNamespaceTypes;
pub use unused_optional_peer_dependencies::UnusedOptionalPeerDependencies;
pub use unused_subpath_exports::UnusedSubpathExports;
pub use unused_subpath_imports::UnusedSubpathImports;
pub use unused_types::UnusedTypes;

use crate::analysis::JsAnalysis;

/// A JS rule. Unlike a manifest rule it reads the shared [`JsAnalysis`], which is built once per run.
pub trait JsRule: Send + Sync {
    /// Identifier, default severity and summary.
    fn meta(&self) -> &'static RuleMeta;

    /// Reports every finding to `out`.
    fn check(&self, analysis: &JsAnalysis<'_>, out: &mut Emitter<'_>);

    /// Whether the rule reads what the other rules recorded and so runs after them. The default runs in parallel with
    /// the rest.
    fn runs_last(&self) -> bool {
        false
    }
}

/// Every JS rule, in the order their diagnostics are merged.
#[must_use]
pub fn rules() -> Vec<Box<dyn JsRule>> {
    vec![
        Box::new(UnusedDependencies),
        Box::new(UnusedDevDependencies),
        Box::new(UnlistedDependencies),
        Box::new(UnresolvedImports),
        Box::new(StaleMocks),
        Box::new(UnlistedBinaries),
        Box::new(UnusedOptionalPeerDependencies),
        Box::new(UnusedFiles),
        Box::new(UnusedSubpathImports),
        Box::new(UnusedSubpathExports),
        Box::new(UnusedExports),
        Box::new(UnusedTypes),
        Box::new(UnusedNamespaceExports),
        Box::new(UnusedNamespaceTypes),
        Box::new(UnusedEnumMembers),
        Box::new(UnusedNamespaceMembers),
        Box::new(DuplicateExports),
        Box::new(CircularImports),
        Box::new(UnparseableFiles),
        Box::new(StaleJsConfig),
    ]
}