pitchfork-cli 2.21.0

Daemons with DX
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

use crate::Result;
use crate::pitchfork_toml::PitchforkToml;
use schemars::schema_for;

/// Generate JSON Schema for pitchfork.toml configuration
#[derive(Debug, clap::Args)]
#[clap(hide = true)]
pub struct Schema;

impl Schema {
    pub async fn run(&self) -> Result<()> {
        let schema = schema_for!(PitchforkToml);
        let json = serde_json::to_string_pretty(&schema).unwrap();
        println!("{json}");
        Ok(())
    }
}

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

    #[test]
    fn includes_all_config_sections() {
        let schema = serde_json::to_value(schema_for!(PitchforkToml)).unwrap();
        let properties = schema["properties"].as_object().unwrap();

        for section in [
            "daemons",
            "env",
            "groups",
            "namespace",
            "namespaces",
            "settings",
            "slugs",
        ] {
            assert!(
                properties.contains_key(section),
                "schema is missing the `{section}` config section"
            );
        }
        assert!(!properties.contains_key("path"));
        assert!(
            schema["required"]
                .as_array()
                .is_none_or(|required| required.is_empty()),
            "top-level config sections must remain optional"
        );
        assert_eq!(
            schema["$defs"]["GroupEntryRaw"]["properties"]["daemons"]["items"]["$ref"],
            "#/$defs/DaemonId",
            "group members must use the daemon ID schema"
        );
    }
}