docgarden 0.1.0-rc0

Mechanical repository-knowledge linter for agentic engineering repositories
Documentation 
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

use std::path::Path;

use anyhow::{Context, Result};

pub fn repository_relative_path(root: &Path, path: &Path) -> Result<String> {
    Ok(path
        .strip_prefix(root)
        .with_context(|| format!("{} is not under {}", path.display(), root.display()))?
        .to_string_lossy()
        .replace('\\', "/"))
}

#[cfg(test)]
mod tests {
    use std::path::Path;

    use super::repository_relative_path;

    #[test]
    fn returns_relative_path_when_under_root() {
        let root = Path::new("/repo");
        let path = Path::new("/repo/docs/guide.md");
        assert_eq!(
            repository_relative_path(root, path).unwrap(),
            "docs/guide.md"
        );
    }

    #[test]
    fn errors_when_path_is_not_under_root() {
        let root = Path::new("/repo");
        let path = Path::new("/other/file.md");
        let err = repository_relative_path(root, path).unwrap_err();
        assert!(err.to_string().contains("is not under"));
    }
}