agentnative 0.5.0

The agent-native CLI linter — audit whether your CLI follows agent-readiness principles
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

//! Shared applicability gate for list-style CLI audits.
//!
//! `p7-should-limit` and `p7-may-cursor-pagination` only apply when the
//! target CLI has list-style subcommands. A behavioral-layer heuristic looks
//! for common list verbs in the top-level subcommand surface.
//!
//! Verbs covered: `list`, `ls`, `search`, `query`, `find`, `show`, `get`.
//! A CLI without any of these vacuously skips the audit.

use crate::runner::HelpOutput;

const LIST_VERBS: &[&str] = &["list", "ls", "search", "query", "find", "show", "get"];

/// True iff the help text advertises at least one top-level subcommand
/// whose name matches a list-style verb (case-insensitive).
pub(crate) fn has_list_style_subcommand(help: &HelpOutput) -> bool {
    help.subcommands()
        .iter()
        .any(|s| LIST_VERBS.iter().any(|verb| s.eq_ignore_ascii_case(verb)))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn detects_list_verb() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  list    List items.\n  build   Build.\n",
        );
        assert!(has_list_style_subcommand(&help));
    }

    #[test]
    fn detects_search_verb() {
        let help =
            HelpOutput::from_raw("Usage: tool [COMMAND]\n\nCommands:\n  search    Search items.\n");
        assert!(has_list_style_subcommand(&help));
    }

    #[test]
    fn case_insensitive_match() {
        let help =
            HelpOutput::from_raw("Usage: tool [COMMAND]\n\nCommands:\n  LIST    UPPERCASE.\n");
        assert!(has_list_style_subcommand(&help));
    }

    #[test]
    fn rejects_non_list_verbs() {
        // Sanity check against the verb list — `audit`, `build`, `run` are
        // common non-list verbs that should fail the gate.
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  audit    Run audits.\n  build    Build.\n  run    Run.\n",
        );
        assert!(!has_list_style_subcommand(&help));
    }

    #[test]
    fn empty_subcommand_list_returns_false() {
        let help = HelpOutput::from_raw("Usage: tool [OPTIONS]\n\nOptions:\n  -h, --help\n");
        assert!(!has_list_style_subcommand(&help));
    }
}