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
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

//! Audit: `p3-may-examples-subcommand`.
//!
//! Dedicated `examples` subcommand or `--examples` flag for curated usage
//! patterns. MAY-tier; mirrors the `p2-schema-print` detection shape.

use crate::audit::Audit;
use crate::project::Project;
use crate::runner::HelpOutput;
use crate::types::{AuditGroup, AuditLayer, AuditResult, AuditStatus, Confidence};

pub struct ExamplesSubcommandAudit;

impl Audit for ExamplesSubcommandAudit {
    fn id(&self) -> &str {
        "p3-examples-subcommand"
    }

    fn label(&self) -> &'static str {
        "`examples` subcommand or `--examples` flag for curated usage patterns"
    }

    fn group(&self) -> AuditGroup {
        AuditGroup::P3
    }

    fn layer(&self) -> AuditLayer {
        AuditLayer::Behavioral
    }

    fn covers(&self) -> &'static [&'static str] {
        &["p3-may-examples-subcommand"]
    }

    fn applicable(&self, project: &Project) -> bool {
        project.runner.is_some()
    }

    fn run(&self, project: &Project) -> anyhow::Result<AuditResult> {
        let status = match project.help_output() {
            None => AuditStatus::Skip("could not probe --help".into()),
            Some(help) => audit_examples_subcommand(help),
        };

        Ok(AuditResult {
            id: self.id().to_string(),
            label: self.label().into(),
            group: self.group(),
            layer: self.layer(),
            status,
            confidence: Confidence::High,
        })
    }
}

pub(crate) fn audit_examples_subcommand(help: &HelpOutput) -> AuditStatus {
    let has_flag = help.flags().iter().any(|f| f.matches("--examples"));
    if has_flag {
        return AuditStatus::Pass;
    }
    let has_subcmd = help
        .subcommands()
        .iter()
        .any(|s| s.eq_ignore_ascii_case("examples"));
    if has_subcmd {
        return AuditStatus::Pass;
    }
    // Fallback: scan raw for `  examples  ` line the parser may have skipped.
    let in_section = help
        .raw()
        .lines()
        .any(|line| line.starts_with("  ") && line.trim_start().starts_with("examples"));
    if in_section {
        return AuditStatus::Pass;
    }

    AuditStatus::Warn(
        "no `examples` subcommand or `--examples` flag found. MAY-tier — \
         a curated usage block keeps agents from hunting through long help text."
            .into(),
    )
}

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

    #[test]
    fn pass_when_subcommand_present() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  audit    Run audits\n  examples Show usage\n",
        );
        assert_eq!(audit_examples_subcommand(&help), AuditStatus::Pass);
    }

    #[test]
    fn pass_when_flag_present() {
        let help = HelpOutput::from_raw(
            "Options:\n      --examples    Show curated usage.\n  -h, --help    Show help.\n",
        );
        assert_eq!(audit_examples_subcommand(&help), AuditStatus::Pass);
    }

    #[test]
    fn warn_when_missing() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  audit    Run audits.\n  -h, --help    Show help.\n",
        );
        match audit_examples_subcommand(&help) {
            AuditStatus::Warn(msg) => assert!(msg.contains("examples")),
            other => panic!("expected Warn, got {other:?}"),
        }
    }
}