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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
use std::collections::HashMap;
use std::fs;
use std::path::{Path, PathBuf};
use std::sync::OnceLock;
use std::time::Duration;

use anyhow::{Context, Result, bail};
use serde::Serialize;

use crate::runner::{BinaryRunner, HelpOutput};

/// Maximum directory recursion depth for source file walk.
const MAX_DEPTH: usize = 20;
/// Maximum number of source files to collect.
const MAX_FILES: usize = 10_000;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Language {
    Rust,
    Python,
    Go,
    Node,
}

#[derive(Debug, Clone)]
pub struct ParsedFile {
    pub source: String,
}

pub struct Project {
    pub path: PathBuf,
    pub language: Option<Language>,
    pub binary_paths: Vec<PathBuf>,
    pub manifest_path: Option<PathBuf>,
    pub runner: Option<BinaryRunner>,
    pub include_tests: bool,
    pub(crate) parsed_files: OnceLock<HashMap<PathBuf, ParsedFile>>,
    pub(crate) help_output: OnceLock<Option<HelpOutput>>,
}

impl std::fmt::Debug for Project {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Project")
            .field("path", &self.path)
            .field("language", &self.language)
            .field("binary_paths", &self.binary_paths)
            .field("manifest_path", &self.manifest_path)
            .field("has_runner", &self.runner.is_some())
            .field("include_tests", &self.include_tests)
            .field(
                "parsed_files_count",
                &self.parsed_files.get().map_or(0, |m| m.len()),
            )
            .field("help_probed", &self.help_output.get().is_some())
            .finish()
    }
}

impl Project {
    pub fn discover(path: &Path) -> Result<Project> {
        let path = path
            .canonicalize()
            .with_context(|| format!("path does not exist: {}", path.display()))?;

        let meta = fs::metadata(&path)
            .with_context(|| format!("cannot read metadata: {}", path.display()))?;

        if meta.is_file() {
            if !is_executable(&meta) {
                bail!("not an executable file: {}", path.display());
            }
            let runner = BinaryRunner::new(path.clone(), Duration::from_secs(5)).ok();
            return Ok(Project {
                path: path.clone(),
                language: None,
                binary_paths: vec![path],
                manifest_path: None,
                runner,
                include_tests: false,
                parsed_files: OnceLock::new(),
                help_output: OnceLock::new(),
            });
        }

        // Directory path — detect language from manifest
        let (language, manifest_path) = detect_language(&path);
        let binary_paths = discover_binaries(&path, language, manifest_path.as_deref());

        let runner = if binary_paths.is_empty() {
            None
        } else {
            BinaryRunner::new(binary_paths[0].clone(), Duration::from_secs(5)).ok()
        };

        Ok(Project {
            path,
            language,
            binary_paths,
            manifest_path,
            runner,
            include_tests: false,
            parsed_files: OnceLock::new(),
            help_output: OnceLock::new(),
        })
    }

    /// Returns a reference to the runner.
    ///
    /// # Panics
    /// Panics if no runner exists. Only call after `applicable()` confirms a runner is present.
    pub fn runner_ref(&self) -> &BinaryRunner {
        self.runner
            .as_ref()
            .expect("runner must exist when applicable() returns true")
    }

    /// Lazily probe `<binary> --help` exactly once, returning a shared
    /// reference that behavioral checks consume. Returns `None` when the
    /// project has no runner or the help probe fails outright (e.g., binary
    /// missing). `HelpOutput` itself handles partial captures from timeouts
    /// and crashes — those still yield `Some(_)`.
    pub fn help_output(&self) -> Option<&HelpOutput> {
        self.help_output
            .get_or_init(|| {
                let runner = self.runner.as_ref()?;
                HelpOutput::probe(runner).ok()
            })
            .as_ref()
    }

    pub fn parsed_files(&self) -> &HashMap<PathBuf, ParsedFile> {
        self.parsed_files.get_or_init(|| {
            let mut cache = HashMap::new();
            if let Some(lang) = self.language {
                let ext = match lang {
                    Language::Rust => "rs",
                    Language::Python => "py",
                    Language::Go => "go",
                    Language::Node => "js",
                };
                if let Ok(files) = walk_source_files(&self.path, ext, self.include_tests) {
                    for file_path in files {
                        if let Ok(source) = fs::read_to_string(&file_path) {
                            cache.insert(file_path, ParsedFile { source });
                        }
                    }
                }
            }
            cache
        })
    }
}

fn detect_language(dir: &Path) -> (Option<Language>, Option<PathBuf>) {
    let manifests = [
        ("Cargo.toml", Language::Rust),
        ("pyproject.toml", Language::Python),
        ("go.mod", Language::Go),
        ("package.json", Language::Node),
    ];
    for (name, lang) in &manifests {
        let manifest = dir.join(name);
        if manifest.exists() {
            return (Some(*lang), Some(manifest));
        }
    }
    (None, None)
}

fn discover_binaries(
    dir: &Path,
    language: Option<Language>,
    manifest_path: Option<&Path>,
) -> Vec<PathBuf> {
    match language {
        Some(Language::Rust) => discover_rust_binaries(dir, manifest_path),
        Some(Language::Python) => discover_simple_binaries(dir, &["dist", "build"]),
        Some(Language::Go) => {
            // Check for binary with same name as directory
            let mut paths = Vec::new();
            if let Some(name) = dir.file_name().and_then(|n| n.to_str()) {
                let bin = dir.join(name);
                if bin.exists() {
                    paths.push(bin);
                }
            }
            paths
        }
        Some(Language::Node) => discover_simple_binaries(dir, &["node_modules/.bin"]),
        None => vec![],
    }
}

fn discover_rust_binaries(dir: &Path, manifest_path: Option<&Path>) -> Vec<PathBuf> {
    let mut bin_names = Vec::new();

    if let Some(manifest) = manifest_path
        && let Ok(content) = fs::read_to_string(manifest)
        && let Ok(doc) = content.parse::<toml::Table>()
    {
        // Check [[bin]] entries
        if let Some(bins) = doc.get("bin").and_then(|b| b.as_array()) {
            for bin in bins {
                if let Some(name) = bin.get("name").and_then(|n| n.as_str()) {
                    bin_names.push(name.to_string());
                }
            }
        }

        // Fallback to package name if no [[bin]]
        if bin_names.is_empty()
            && let Some(name) = doc
                .get("package")
                .and_then(|p| p.get("name"))
                .and_then(|n| n.as_str())
        {
            bin_names.push(name.to_string());
        }
    }

    let mut paths = Vec::new();
    for name in &bin_names {
        // Pick the newer of release/debug by mtime so dev workflows
        // (where `cargo run`/`cargo test` only refresh debug) don't probe
        // a stale release binary. CI scenarios — where typically only one
        // profile is built — fall through cleanly to the existence check.
        // Documented at
        // docs/solutions/test-failures/stale-release-binary-dogfood-fail-2026-05-07.md.
        let release = dir.join("target/release").join(name);
        let debug = dir.join("target/debug").join(name);
        let pick = match (release.exists(), debug.exists()) {
            (true, true) => Some(pick_newer_artifact(&release, &debug)),
            (true, false) => Some(release),
            (false, true) => Some(debug),
            (false, false) => None,
        };
        if let Some(p) = pick {
            paths.push(p);
        }
    }
    paths
}

/// Return the path with the newer mtime. Ties and missing-mtime fall back
/// to `b` (called with the debug path) — matches cargo's dev-flow default
/// where debug is the canonical fresh artifact.
fn pick_newer_artifact(a: &Path, b: &Path) -> PathBuf {
    let a_m = fs::metadata(a).and_then(|m| m.modified()).ok();
    let b_m = fs::metadata(b).and_then(|m| m.modified()).ok();
    match (a_m, b_m) {
        (Some(am), Some(bm)) if am > bm => a.to_path_buf(),
        _ => b.to_path_buf(),
    }
}

fn discover_simple_binaries(dir: &Path, subdirs: &[&str]) -> Vec<PathBuf> {
    let mut paths = Vec::new();
    for subdir in subdirs {
        let bin_dir = dir.join(subdir);
        if bin_dir.is_dir()
            && let Ok(entries) = fs::read_dir(&bin_dir)
        {
            for entry in entries.flatten() {
                let p = entry.path();
                if p.is_file() {
                    paths.push(p);
                }
            }
        }
    }
    paths
}

fn walk_source_files(dir: &Path, ext: &str, include_tests: bool) -> Result<Vec<PathBuf>> {
    let mut files = Vec::new();
    let mut file_count: usize = 0;
    walk_source_files_inner(dir, ext, include_tests, 0, &mut file_count, &mut files)?;
    Ok(files)
}

fn walk_source_files_inner(
    dir: &Path,
    ext: &str,
    include_tests: bool,
    depth: usize,
    file_count: &mut usize,
    files: &mut Vec<PathBuf>,
) -> Result<()> {
    if depth >= MAX_DEPTH {
        eprintln!(
            "warning: hit {MAX_DEPTH}-level depth limit; narrow the scan with `anc check src/`"
        );
        return Ok(());
    }
    if *file_count >= MAX_FILES {
        eprintln!("warning: hit {MAX_FILES}-file limit; narrow the scan with `anc check src/`");
        return Ok(());
    }

    let entries =
        fs::read_dir(dir).with_context(|| format!("cannot read directory: {}", dir.display()))?;

    for entry in entries {
        if *file_count >= MAX_FILES {
            break;
        }
        let entry = entry?;
        let path = entry.path();
        let file_name = entry.file_name();
        let name = file_name.to_string_lossy();

        // Skip hidden dirs, target/ always; tests/ unless --include-tests
        if path.is_dir() {
            if name.starts_with('.') || name == "target" {
                continue;
            }
            if name == "tests" && !include_tests {
                continue;
            }
            walk_source_files_inner(&path, ext, include_tests, depth + 1, file_count, files)?;
        } else if path.extension().is_some_and(|e| e == ext) {
            files.push(path);
            *file_count += 1;
        }
    }
    Ok(())
}

#[cfg(unix)]
fn is_executable(meta: &fs::Metadata) -> bool {
    use std::os::unix::fs::PermissionsExt;
    meta.permissions().mode() & 0o111 != 0
}

#[cfg(not(unix))]
fn is_executable(_meta: &fs::Metadata) -> bool {
    true
}

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

    fn temp_dir() -> PathBuf {
        let dir = std::env::temp_dir().join(format!("agentnative-test-{}", std::process::id()));
        fs::create_dir_all(&dir).expect("create test dir");
        dir
    }

    #[test]
    fn test_rust_project_detected() {
        let dir = temp_dir().join("rust-proj");
        fs::create_dir_all(&dir).expect("create test dir");
        fs::write(
            dir.join("Cargo.toml"),
            r#"[package]
name = "myapp"
version = "0.1.0"
"#,
        )
        .expect("write test Cargo.toml");

        let project = Project::discover(&dir).expect("discover test project");
        assert_eq!(project.language, Some(Language::Rust));
        assert!(project.manifest_path.is_some());
    }

    #[test]
    fn test_executable_file() {
        let dir = temp_dir().join("exe-test");
        fs::create_dir_all(&dir).expect("create test dir");
        let bin = dir.join("mybin");
        fs::write(&bin, "#!/bin/sh\necho hi").expect("write test binary");

        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            fs::set_permissions(&bin, fs::Permissions::from_mode(0o755))
                .expect("set test permissions");
        }

        let project = Project::discover(&bin).expect("discover test project");
        assert_eq!(project.language, None);
        assert_eq!(project.binary_paths.len(), 1);
    }

    #[test]
    fn test_no_manifest_directory() {
        let dir = temp_dir().join("empty-proj");
        fs::create_dir_all(&dir).expect("create test dir");

        let project = Project::discover(&dir).expect("discover test project");
        assert_eq!(project.language, None);
        assert!(project.binary_paths.is_empty());
    }

    #[test]
    fn test_cargo_toml_with_bin_entries() {
        let dir = temp_dir().join("bin-entries");
        fs::create_dir_all(&dir).expect("create test dir");
        fs::write(
            dir.join("Cargo.toml"),
            r#"[package]
name = "myapp"
version = "0.1.0"

[[bin]]
name = "cli1"
path = "src/main.rs"

[[bin]]
name = "cli2"
path = "src/cli2.rs"
"#,
        )
        .expect("write test Cargo.toml");

        let project = Project::discover(&dir).expect("discover test project");
        assert_eq!(project.language, Some(Language::Rust));
        // Binaries won't exist on disk, so binary_paths should be empty
        assert!(project.binary_paths.is_empty());

        // Verify we parsed the names correctly by checking the discover function directly
        let names = {
            let content = fs::read_to_string(dir.join("Cargo.toml")).expect("read test Cargo.toml");
            let doc: toml::Table = content.parse().expect("parse TOML");
            let bins = doc
                .get("bin")
                .expect("bin section")
                .as_array()
                .expect("bin is array");
            bins.iter()
                .filter_map(|b| b.get("name").and_then(|n| n.as_str()).map(String::from))
                .collect::<Vec<_>>()
        };
        assert_eq!(names, vec!["cli1", "cli2"]);
    }

    #[test]
    fn test_nonexistent_path_errors() {
        let result = Project::discover(Path::new("/tmp/agentnative-does-not-exist-xyz"));
        assert!(result.is_err());
    }

    /// Regression for the v0.4.0-spec-sync stale-release-binary trap:
    /// when both `target/release/<bin>` and `target/debug/<bin>` exist,
    /// pick the newer one by mtime (so dev workflows where `cargo run`
    /// only refreshes debug don't probe a stale release binary). See
    /// docs/solutions/test-failures/stale-release-binary-dogfood-fail-2026-05-07.md.
    #[cfg(unix)]
    #[test]
    fn test_discover_picks_newer_artifact_by_mtime() {
        use std::fs::File;
        use std::os::unix::fs::PermissionsExt;
        use std::time::{Duration, SystemTime};

        let dir = temp_dir().join("mtime-pick");
        fs::create_dir_all(dir.join("target/release")).expect("mkdir release");
        fs::create_dir_all(dir.join("target/debug")).expect("mkdir debug");
        fs::write(
            dir.join("Cargo.toml"),
            r#"[package]
name = "myapp"
version = "0.1.0"
"#,
        )
        .expect("write Cargo.toml");

        let release_bin = dir.join("target/release/myapp");
        let debug_bin = dir.join("target/debug/myapp");
        fs::write(&release_bin, "#!/bin/sh\necho stale").expect("write release binary");
        fs::write(&debug_bin, "#!/bin/sh\necho fresh").expect("write debug binary");
        fs::set_permissions(&release_bin, fs::Permissions::from_mode(0o755))
            .expect("chmod release");
        fs::set_permissions(&debug_bin, fs::Permissions::from_mode(0o755)).expect("chmod debug");

        // Stamp release with an old mtime; debug stays at "now".
        let one_hour_ago = SystemTime::now() - Duration::from_secs(3600);
        File::options()
            .write(true)
            .open(&release_bin)
            .expect("open release for mtime")
            .set_modified(one_hour_ago)
            .expect("set release mtime");

        let project = Project::discover(&dir).expect("discover test project");
        assert_eq!(project.binary_paths.len(), 1);
        assert_eq!(
            project.binary_paths[0], debug_bin,
            "discover should pick the newer (debug) binary when release is stale; \
             got {:?}",
            project.binary_paths[0],
        );
    }

    /// Symmetric case: when release is newer than debug (e.g., `cargo build
    /// --release` was just run), `pick_newer_artifact` returns release.
    #[cfg(unix)]
    #[test]
    fn test_discover_picks_release_when_newer() {
        use std::fs::File;
        use std::os::unix::fs::PermissionsExt;
        use std::time::{Duration, SystemTime};

        let dir = temp_dir().join("mtime-release");
        fs::create_dir_all(dir.join("target/release")).expect("mkdir release");
        fs::create_dir_all(dir.join("target/debug")).expect("mkdir debug");
        fs::write(
            dir.join("Cargo.toml"),
            r#"[package]
name = "myapp"
version = "0.1.0"
"#,
        )
        .expect("write Cargo.toml");

        let release_bin = dir.join("target/release/myapp");
        let debug_bin = dir.join("target/debug/myapp");
        fs::write(&release_bin, "#!/bin/sh\necho fresh").expect("write release binary");
        fs::write(&debug_bin, "#!/bin/sh\necho stale").expect("write debug binary");
        fs::set_permissions(&release_bin, fs::Permissions::from_mode(0o755))
            .expect("chmod release");
        fs::set_permissions(&debug_bin, fs::Permissions::from_mode(0o755)).expect("chmod debug");

        // Stamp debug with an old mtime; release stays at "now".
        let one_hour_ago = SystemTime::now() - Duration::from_secs(3600);
        File::options()
            .write(true)
            .open(&debug_bin)
            .expect("open debug for mtime")
            .set_modified(one_hour_ago)
            .expect("set debug mtime");

        let project = Project::discover(&dir).expect("discover test project");
        assert_eq!(project.binary_paths.len(), 1);
        assert_eq!(
            project.binary_paths[0], release_bin,
            "discover should pick release when it's newer than debug",
        );
    }

    #[test]
    fn test_non_executable_file_errors() {
        let dir = temp_dir().join("noexec-test");
        fs::create_dir_all(&dir).expect("create test dir");
        let file = dir.join("regular.txt");
        fs::write(&file, "just text").expect("write test file");

        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            fs::set_permissions(&file, fs::Permissions::from_mode(0o644))
                .expect("set test permissions");
        }

        let result = Project::discover(&file);
        assert!(result.is_err());
        let err = result
            .expect_err("should reject non-executable file")
            .to_string();
        assert!(err.contains("not an executable"), "got: {err}");
    }

    #[test]
    fn test_walk_excludes_tests_by_default() {
        let dir = temp_dir().join("walk-tests-default");
        let src = dir.join("src");
        let tests = dir.join("tests");
        fs::create_dir_all(&src).expect("create test src dir");
        fs::create_dir_all(&tests).expect("create test tests dir");
        fs::write(src.join("main.rs"), "fn main() {}").expect("write test file");
        fs::write(tests.join("test_foo.rs"), "fn test() {}").expect("write test file");

        let files = walk_source_files(&dir, "rs", false).expect("walk source files");
        assert_eq!(files.len(), 1);
        assert!(files[0].ends_with("main.rs"));
    }

    #[test]
    fn test_walk_includes_tests_when_enabled() {
        let dir = temp_dir().join("walk-tests-enabled");
        let src = dir.join("src");
        let tests = dir.join("tests");
        fs::create_dir_all(&src).expect("create test src dir");
        fs::create_dir_all(&tests).expect("create test tests dir");
        fs::write(src.join("main.rs"), "fn main() {}").expect("write test file");
        fs::write(tests.join("test_foo.rs"), "fn test() {}").expect("write test file");

        let files = walk_source_files(&dir, "rs", true).expect("walk source files");
        assert_eq!(files.len(), 2);
    }

    #[test]
    fn test_walk_always_excludes_target() {
        let dir = temp_dir().join("walk-target-excl");
        let src = dir.join("src");
        let target = dir.join("target").join("debug");
        fs::create_dir_all(&src).expect("create test src dir");
        fs::create_dir_all(&target).expect("create test target dir");
        fs::write(src.join("main.rs"), "fn main() {}").expect("write test file");
        fs::write(target.join("build.rs"), "fn build() {}").expect("write test file");

        let files = walk_source_files(&dir, "rs", true).expect("walk source files");
        assert_eq!(files.len(), 1);
        assert!(files[0].ends_with("main.rs"));
    }

    #[test]
    fn test_include_tests_field_default() {
        let dir = temp_dir().join("include-tests-default");
        fs::create_dir_all(&dir).expect("create test dir");
        fs::write(
            dir.join("Cargo.toml"),
            "[package]\nname = \"test\"\nversion = \"0.1.0\"\n",
        )
        .expect("write test Cargo.toml");

        let project = Project::discover(&dir).expect("discover test project");
        assert!(!project.include_tests);
    }
}