osp-cli 1.5.1

CLI and REPL for querying and managing OSP infrastructure data
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

use clap::CommandFactory;
use osp_cli::cli::Cli;
use std::collections::BTreeSet;

fn set(values: &[&str]) -> BTreeSet<String> {
    values.iter().map(|value| (*value).to_string()).collect()
}

fn subcommand_names(cmd: &clap::Command) -> BTreeSet<String> {
    cmd.get_subcommands()
        .map(|sub| sub.get_name().to_string())
        .filter(|name| !is_ignored_subcommand(name))
        .collect()
}

fn is_ignored_subcommand(name: &str) -> bool {
    matches!(name, "help" | "completion" | "external" | "repl" | "intro")
}

fn assert_subcommands(cmd: &clap::Command, name: &str, allowed: BTreeSet<String>) {
    let sub = cmd
        .get_subcommands()
        .find(|sub| sub.get_name() == name)
        .unwrap_or_else(|| panic!("missing subcommand: {name}"));
    let actual = subcommand_names(sub);
    assert_eq!(actual, allowed, "unexpected subcommands for `{name}`");
}

#[test]
fn builtin_command_verbs_are_consistent() {
    let cmd = Cli::command();
    let top_level = subcommand_names(&cmd);
    let allowed_top = set(&["plugins", "doctor", "theme", "config", "history"]);
    assert_eq!(
        top_level, allowed_top,
        "top-level commands should be nouns only"
    );

    assert_subcommands(
        &cmd,
        "plugins",
        set(&[
            "list",
            "commands",
            "config",
            "refresh",
            "enable",
            "disable",
            "clear-state",
            "select-provider",
            "clear-provider",
            "doctor",
        ]),
    );
    assert_subcommands(&cmd, "theme", set(&["list", "show", "use"]));
    assert_subcommands(
        &cmd,
        "config",
        set(&["show", "get", "explain", "set", "unset", "doctor"]),
    );
    assert_subcommands(&cmd, "history", set(&["list", "prune", "clear"]));
    // doctor uses selectors rather than verbs.
    assert_subcommands(
        &cmd,
        "doctor",
        set(&["config", "plugins", "theme", "all", "last"]),
    );

    for name in top_level {
        assert_eq!(
            name,
            name.to_ascii_lowercase(),
            "command `{name}` should be lowercase"
        );
    }
}