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
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Audit: `p7-may-cursor-pagination`.
//!
//! Cursor-based pagination flags (`--after`, `--before`, `--cursor`, `--page`)
//! for efficient traversal of large result sets. MAY-tier; applicability
//! gated on the presence of a list-style subcommand.

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

const CURSOR_FLAGS: &[&str] = &["--after", "--before", "--cursor", "--page", "--offset"];

pub struct CursorPaginationAudit;

impl Audit for CursorPaginationAudit {
    fn id(&self) -> &str {
        "p7-cursor-pagination"
    }

    fn label(&self) -> &'static str {
        "Cursor-based pagination flags for list traversal"
    }

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

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

    fn covers(&self) -> &'static [&'static str] {
        &["p7-may-cursor-pagination"]
    }

    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_cursor_pagination(help),
        };

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

pub(crate) fn audit_cursor_pagination(help: &HelpOutput) -> AuditStatus {
    if !has_list_style_subcommand(help) {
        return AuditStatus::Skip(
            "no list-style subcommand detected; vacuous skip for the list-only MAY.".into(),
        );
    }

    let has_cursor = help
        .flags()
        .iter()
        .any(|f| CURSOR_FLAGS.iter().any(|name| f.matches(name)));

    if has_cursor {
        AuditStatus::Pass
    } else {
        AuditStatus::Warn(format!(
            "list-style subcommand present but no cursor/page flag advertised \
             (looked for {}). MAY-tier — cursor pagination lets agents \
             traverse large result sets without re-scanning earlier pages.",
            CURSOR_FLAGS.join(", "),
        ))
    }
}

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

    #[test]
    fn skip_when_no_list_subcommand() {
        let help =
            HelpOutput::from_raw("Usage: tool [COMMAND]\n\nCommands:\n  audit    Run audits.\n");
        match audit_cursor_pagination(&help) {
            AuditStatus::Skip(msg) => assert!(msg.contains("vacuous")),
            other => panic!("expected Skip, got {other:?}"),
        }
    }

    #[test]
    fn pass_with_cursor_flag() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  list     List items.\n\n\
             Options:\n      --cursor <C>    Pagination cursor.\n  -h, --help\n",
        );
        assert_eq!(audit_cursor_pagination(&help), AuditStatus::Pass);
    }

    #[test]
    fn pass_with_after_before_flags() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  search   Search items.\n\n\
             Options:\n      --after <ID>    Start after.\n      --before <ID>    End before.\n",
        );
        assert_eq!(audit_cursor_pagination(&help), AuditStatus::Pass);
    }

    #[test]
    fn warn_when_list_without_cursor() {
        let help = HelpOutput::from_raw(
            "Usage: tool [COMMAND]\n\nCommands:\n  list     List items.\n\n\
             Options:\n  -h, --help    Show help.\n",
        );
        match audit_cursor_pagination(&help) {
            AuditStatus::Warn(msg) => assert!(msg.contains("cursor")),
            other => panic!("expected Warn, got {other:?}"),
        }
    }
}