agentnative 0.4.0

The agent-native CLI linter — check 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

//! Check: `p2-should-json-aliases`.
//!
//! `--json` and `--jsonl` are accepted as short-form aliases for
//! `--output json` and `--output jsonl`. The short forms work alongside the
//! canonical enum so agents and pipelines can use either spelling.
//!
//! Universal applicability. Pass when at least one of `--json` / `--jsonl`
//! is advertised. Warn when neither short form is present (the SHOULD is not
//! met). Skip when the help cannot be probed.

use crate::check::Check;
use crate::project::Project;
use crate::runner::HelpOutput;
use crate::types::{CheckGroup, CheckLayer, CheckResult, CheckStatus, Confidence};

pub struct JsonAliasesCheck;

impl Check for JsonAliasesCheck {
    fn id(&self) -> &str {
        "p2-json-aliases"
    }

    fn label(&self) -> &'static str {
        "--json / --jsonl short aliases for --output"
    }

    fn group(&self) -> CheckGroup {
        CheckGroup::P2
    }

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

    fn covers(&self) -> &'static [&'static str] {
        &["p2-should-json-aliases"]
    }

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

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

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

/// Core unit for tests. Pass when either alias is present; Warn otherwise.
pub(crate) fn check_json_aliases(help: &HelpOutput) -> CheckStatus {
    let has_json = help.flags().iter().any(|f| f.matches("--json"));
    let has_jsonl = help.flags().iter().any(|f| f.matches("--jsonl"));

    if has_json || has_jsonl {
        CheckStatus::Pass
    } else {
        CheckStatus::Warn(
            "no --json or --jsonl short alias found. Agents and pipelines \
             benefit from short forms alongside the canonical `--output` enum."
                .into(),
        )
    }
}

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

    #[test]
    fn happy_path_json_alias() {
        let help = HelpOutput::from_raw(
            "Options:\n      --json    Emit JSON.\n  -h, --help    Show help.\n",
        );
        assert_eq!(check_json_aliases(&help), CheckStatus::Pass);
    }

    #[test]
    fn happy_path_jsonl_alias() {
        let help = HelpOutput::from_raw(
            "Options:\n      --jsonl   Emit JSONL.\n  -h, --help    Show help.\n",
        );
        assert_eq!(check_json_aliases(&help), CheckStatus::Pass);
    }

    #[test]
    fn warn_no_alias() {
        let help = HelpOutput::from_raw(
            "Options:\n      --output <FORMAT>   Output format.\n  -h, --help    Show help.\n",
        );
        match check_json_aliases(&help) {
            CheckStatus::Warn(msg) => assert!(msg.contains("--json")),
            other => panic!("expected Warn, got {other:?}"),
        }
    }
}