fallow-core 2.87.0

Analysis orchestration for fallow codebase intelligence (dead code, duplication, plugins, cross-reference)
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

//! pkg-utils library build-config plugin.
//!
//! `@sanity/pkg-utils` builds npm packages from a `package.config.ts` build
//! config (and an optional `package.bundle.ts` Vite bundle config). Those files
//! are discovered by the tool on a filename convention rather than imported from
//! source, so without this plugin they surface as `unused-file`. Activation is
//! gated strictly on the `@sanity/pkg-utils` dependency (exact match): a plain
//! `@sanity/client` consumer must NOT get its `package.config.ts` auto-credited,
//! which is why this is a dedicated plugin and not an extension of the broad
//! `@sanity/`-enabler CMS `sanity` plugin.
//!
//! Library source entries (`src/_exports/**`) are not seeded here: the
//! `exports.source` condition resolution plus the workspace-package fallback
//! already keep them reachable, so parsing `package.bundle.ts`'s `build.lib.entry`
//! would be dead weight.

use super::Plugin;

const ENABLERS: &[&str] = &["@sanity/pkg-utils"];

const ALWAYS_USED: &[&str] = &[
    "package.config.{ts,js,mts,mjs,cts,cjs}",
    "**/package.config.{ts,js,mts,mjs,cts,cjs}",
    "package.bundle.{ts,js,mts,mjs,cts,cjs}",
    "**/package.bundle.{ts,js,mts,mjs,cts,cjs}",
];

const TOOLING_DEPENDENCIES: &[&str] = &["@sanity/pkg-utils"];

define_plugin! {
    struct PkgUtilsPlugin => "pkg-utils",
    enablers: ENABLERS,
    always_used: ALWAYS_USED,
    tooling_dependencies: TOOLING_DEPENDENCIES,
}

#[cfg(test)]
mod tests {
    use std::path::Path;

    use super::*;

    #[test]
    fn enabler_is_exact_pkg_utils_only() {
        let plugin = PkgUtilsPlugin;
        assert_eq!(plugin.enablers(), &["@sanity/pkg-utils"]);
    }

    #[test]
    fn activates_when_pkg_utils_dependency_present() {
        let plugin = PkgUtilsPlugin;
        let deps = vec!["@sanity/pkg-utils".to_string()];
        assert!(plugin.is_enabled_with_deps(&deps, Path::new("/project")));
    }

    #[test]
    fn does_not_activate_without_pkg_utils_dependency() {
        let plugin = PkgUtilsPlugin;
        let deps = vec!["vite".to_string(), "typescript".to_string()];
        assert!(!plugin.is_enabled_with_deps(&deps, Path::new("/project")));
    }

    #[test]
    fn does_not_activate_for_plain_sanity_client_consumer() {
        let plugin = PkgUtilsPlugin;
        let deps = vec!["@sanity/client".to_string(), "@sanity/vision".to_string()];
        assert!(!plugin.is_enabled_with_deps(&deps, Path::new("/project")));
    }

    #[test]
    fn always_used_covers_root_and_nested_build_configs() {
        let plugin = PkgUtilsPlugin;
        let patterns = plugin.always_used();
        for expected in [
            "package.config.{ts,js,mts,mjs,cts,cjs}",
            "**/package.config.{ts,js,mts,mjs,cts,cjs}",
            "package.bundle.{ts,js,mts,mjs,cts,cjs}",
            "**/package.bundle.{ts,js,mts,mjs,cts,cjs}",
        ] {
            assert!(
                patterns.contains(&expected),
                "always_used should include {expected}"
            );
        }
    }

    #[test]
    fn credits_pkg_utils_as_tooling_dependency() {
        let plugin = PkgUtilsPlugin;
        assert!(plugin.tooling_dependencies().contains(&"@sanity/pkg-utils"));
    }
}