skif-cli 0.2.0

Command-line interface for skif, a dependency and package-manager linter for JS/TS monorepos.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! End-to-end tests of layered configuration: an organisation file, a preset it extends, a pnpm project with a
//! project file and a package file, a standalone package that opts out, and scoped overrides.

#![allow(clippy::unwrap_used, clippy::expect_used)]

mod support;

use std::collections::BTreeMap;
use std::fs;
use std::path::Path;

use serde_json::Value;
use support::{fixture, run, skif};

fn json(path: &Path, extra: &[&str]) -> (i32, Value) {
    let result = run(skif().args(["--format", "json"]).args(extra).arg(path));
    assert!(
        result.code == 0 || result.code == 1,
        "{}{}",
        result.stdout,
        result.stderr
    );
    (result.code, result.json())
}

/// The severity of every `empty-dependencies` diagnostic by file.
fn levels(report: &Value) -> BTreeMap<String, String> {
    report["diagnostics"]
        .as_array()
        .unwrap()
        .iter()
        .filter(|diagnostic| diagnostic["rule"] == "empty-dependencies")
        .map(|diagnostic| {
            (
                diagnostic["location"]["path"].as_str().unwrap().to_owned(),
                diagnostic["severity"].as_str().unwrap().to_owned(),
            )
        })
        .collect()
}

fn expected(levels: &[(&str, &str)]) -> BTreeMap<String, String> {
    levels
        .iter()
        .map(|(path, level)| ((*path).to_owned(), (*level).to_owned()))
        .collect()
}

#[test]
fn every_layer_decides_the_level_of_its_own_packages() {
    let dir = fixture("inheritance");
    let (code, report) = json(dir.path(), &["-r"]);
    assert_eq!(code, 1, "{report}");
    assert_eq!(
        levels(&report),
        expected(&[
            // the preset the organisation file extends
            ("web/packages/plain/package.json", "warning"),
            // an override of the organisation file, selected by directory
            ("web/packages/gen/package.json", "info"),
            // an override of the project file, selected by name
            ("web/packages/app/package.json", "error"),
            // `root = true` opts out of the organisation file and its preset, so the rule's own default applies
            ("tools/standalone/package.json", "error"),
            // the package file of `legacy-ui` turns the rule off for that package
        ])
    );
}

#[test]
fn the_package_file_only_silences_its_own_package() {
    let dir = fixture("inheritance");
    let (_, report) = json(dir.path(), &["-r"]);
    let paths: Vec<_> = levels(&report).into_keys().collect();
    assert!(paths.iter().all(|path| !path.contains("legacy-ui")), "{paths:?}");
    assert!(paths.iter().any(|path| path.contains("plain")), "{paths:?}");
}

#[test]
fn a_project_run_on_its_own_sees_the_same_levels() {
    let dir = fixture("inheritance");
    fs::create_dir(dir.path().join(".git")).unwrap();
    let (_, project) = json(&dir.path().join("web"), &[]);
    assert_eq!(
        levels(&project),
        expected(&[
            ("packages/plain/package.json", "warning"),
            ("packages/gen/package.json", "info"),
            ("packages/app/package.json", "error"),
        ])
    );
}

#[test]
fn a_command_line_level_beats_every_override() {
    let dir = fixture("inheritance");
    let (_, report) = json(dir.path(), &["-r", "--rule", "empty-dependencies=info"]);
    let found = levels(&report);
    assert!(!found.is_empty());
    assert!(found.values().all(|level| level == "info"), "{found:?}");
}

#[test]
fn a_package_file_with_a_root_scoped_key_fails_the_run() {
    let dir = fixture("inheritance");
    fs::write(
        dir.path().join("web/packages/legacy-ui/skif.toml"),
        "[workspace]\nignore-packages = [\"x\"]\n",
    )
    .unwrap();
    let result = run(skif().arg(dir.path().join("web")));
    assert_eq!(result.code, 2, "{}{}", result.stdout, result.stderr);
    assert!(result.stderr.contains("workspace"), "{}", result.stderr);
    assert!(result.stderr.contains("legacy-ui"), "{}", result.stderr);
}

#[test]
fn an_override_that_selects_nothing_leaves_the_output_byte_identical() {
    let dir = fixture("multi/nested");
    let before = run(skif().args(["--format", "json", "-r"]).arg(dir.path()));
    let config = dir.path().join("skif.toml");
    let mut text = fs::read_to_string(&config).unwrap();
    text.push_str(
        "\n[[overrides]]\npackages = [\"nobody\"]\nmax-level = \"info\"\n\n[overrides.rules]\nempty-dependencies = \"off\"\n",
    );
    fs::write(&config, text).unwrap();
    let after = run(skif().args(["--format", "json", "-r"]).arg(dir.path()));
    assert_eq!(after.code, before.code);
    assert_eq!(after.stdout, before.stdout);
}