agent-first-data 0.31.0

A naming convention that lets AI agents understand your data without being told what it means, plus a CLI and library for reading Markdown structure and safely editing structured JSON, TOML, YAML, dotenv, and INI documents.
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#[cfg(all(feature = "stream-redirect", not(feature = "libc")))]
compile_error!("the `stream-redirect` feature must enable the `libc` feature");

#[cfg(all(unix, not(feature = "libc")))]
#[test]
fn capped_read_without_libc_keeps_follow_and_refuses_no_follow() {
    use agent_first_data::document::{DocumentFile, SymlinkPolicy};

    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("config.json");
    std::fs::write(&path, r#"{"k": "v"}"#).unwrap();

    assert!(
        DocumentFile::open_capped_with_policy(&path, None, 1024, SymlinkPolicy::Follow).is_ok()
    );
    let error = DocumentFile::open_capped_with_policy(&path, None, 1024, SymlinkPolicy::NoFollow)
        .unwrap_err();
    assert_eq!(error.code(), "document_unsupported_operation");
    assert!(error.to_string().contains("Cargo feature `libc`"));
}

/// Without this, every test in the file is `cfg(unix)` and the Windows CI leg
/// compiles a target with zero tests that passes while proving nothing. The
/// non-unix `NoFollow` arm is only reachable here, so it is only ever executed
/// here.
#[cfg(not(unix))]
#[test]
fn capped_read_on_non_unix_refuses_no_follow_and_allows_follow() {
    use agent_first_data::document::{DocumentFile, SymlinkPolicy};

    let dir = tempfile::tempdir().unwrap();
    let path = dir.path().join("config.json");
    std::fs::write(&path, r#"{"k": "v"}"#).unwrap();

    assert!(
        DocumentFile::open_capped_with_policy(&path, None, 1024, SymlinkPolicy::Follow).is_ok()
    );
    let error = DocumentFile::open_capped_with_policy(&path, None, 1024, SymlinkPolicy::NoFollow)
        .unwrap_err();
    assert_eq!(error.code(), "document_unsupported_operation");
}

#[cfg(all(unix, feature = "libc"))]
#[test]
fn capped_read_with_libc_atomically_refuses_a_symlink() {
    use agent_first_data::document::{DocumentFile, SymlinkPolicy};

    let dir = tempfile::tempdir().unwrap();
    let target = dir.path().join("target.json");
    let link = dir.path().join("link.json");
    std::fs::write(&target, r#"{"k": "v"}"#).unwrap();
    std::os::unix::fs::symlink(&target, &link).unwrap();

    assert!(
        DocumentFile::open_capped_with_policy(&link, None, 1024, SymlinkPolicy::Follow).is_ok()
    );
    let error = DocumentFile::open_capped_with_policy(&link, None, 1024, SymlinkPolicy::NoFollow)
        .unwrap_err();
    assert_eq!(error.code(), "document_io_failed");
}