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
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

use serde::{Deserialize, Serialize};
use std::fmt;
use std::str::FromStr;

/// Output format for CLI and pipe/MCP modes.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum OutputFormat {
    Json,
    /// Structure-preserving YAML (same semantics as [`OutputFormat::Json`]).
    Yaml,
    Plain,
}

impl OutputFormat {
    /// Return the canonical CLI/config spelling.
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Json => "json",
            Self::Yaml => "yaml",
            Self::Plain => "plain",
        }
    }
}

impl fmt::Display for OutputFormat {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for OutputFormat {
    type Err = String;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        match value {
            "json" => Ok(Self::Json),
            "yaml" => Ok(Self::Yaml),
            "plain" => Ok(Self::Plain),
            _ => Err("invalid output format: expected json, yaml, or plain".to_string()),
        }
    }
}

/// Where a CLI emitter sends its events.
#[cfg(feature = "cli")]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum OutputTo {
    /// Finite one-shot: `result` → stdout, `error`/`progress`/`log` → stderr.
    Split,
    /// Event stream: every event onto stdout.
    Stdout,
    /// Event stream: every event onto stderr.
    Stderr,
}

#[cfg(feature = "cli")]
impl OutputTo {
    /// Return the canonical CLI/config spelling.
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Split => "split",
            Self::Stdout => "stdout",
            Self::Stderr => "stderr",
        }
    }

    /// Parse an `--output-to` value.
    pub fn parse(value: &str) -> Result<Self, String> {
        value.parse()
    }
}

#[cfg(feature = "cli")]
impl fmt::Display for OutputTo {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

#[cfg(feature = "cli")]
impl FromStr for OutputTo {
    type Err = String;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        match value {
            "split" => Ok(Self::Split),
            "stdout" => Ok(Self::Stdout),
            "stderr" => Ok(Self::Stderr),
            _ => Err("unsupported --output-to: expected split, stdout, or stderr".to_string()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::OutputFormat;
    #[cfg(feature = "cli")]
    use super::OutputTo;

    #[test]
    fn output_types_round_trip_text_and_serde() {
        for format in [OutputFormat::Json, OutputFormat::Yaml, OutputFormat::Plain] {
            assert_eq!(format.to_string().parse(), Ok(format));
            assert_eq!(
                serde_json::from_str::<OutputFormat>(
                    &serde_json::to_string(&format).unwrap_or_default()
                )
                .ok(),
                Some(format)
            );
        }
        #[cfg(feature = "cli")]
        {
            for destination in [OutputTo::Split, OutputTo::Stdout, OutputTo::Stderr] {
                assert_eq!(destination.to_string().parse(), Ok(destination));
                assert_eq!(
                    serde_json::from_str::<OutputTo>(
                        &serde_json::to_string(&destination).unwrap_or_default()
                    )
                    .ok(),
                    Some(destination)
                );
            }
        }

        let format_canary = "canary-output-format-secret";
        let format_error = format_canary.parse::<OutputFormat>().unwrap_err();
        assert!(!format_error.contains(format_canary));
        assert!(format_error.contains("json"));

        #[cfg(feature = "cli")]
        {
            let destination_canary = "canary-output-to-secret";
            let destination_error = destination_canary.parse::<OutputTo>().unwrap_err();
            assert!(!destination_error.contains(destination_canary));
            assert!(destination_error.contains("split"));
        }
    }
}