agent-policy 0.6.0

Schema-first generator for coding-agent repo policies and compatibility files.
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

// Raw policy types — directly deserialized from YAML.
// Do not use these types in renderers — use the normalized model instead.

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};

/// Raw deserialized policy as it appears in agent-policy.yaml.
///
/// `Serialize` is required so `serde_json::to_value(&raw)` compiles in the load pipeline.
/// All `Option` fields use `skip_serializing_if` so `None` values are **omitted** from the
/// JSON rather than serialized as `null` — the JSON Schema uses plain type checks (not
/// `["T", "null"]`), so a `null` value would fail validation.
#[derive(Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawPolicy {
    /// Declares the schema version. Use `"1"` for all new files.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema_version: Option<String>,
    pub project: RawProject,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commands: Option<RawCommands>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub paths: Option<RawPaths>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub roles: Option<IndexMap<String, RawRole>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub constraints: Option<RawConstraints>,
    /// List of output target IDs.
    /// Valid values: `"agents-md"`, `"claude-md"`, `"cursor-rules"`, `"gemini-md"`, `"copilot-instructions"`.
    /// Defaults to `["agents-md"]` when omitted.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub outputs: Option<Vec<String>>,
}

#[derive(Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawProject {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
}

#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawCommands {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub install: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dev: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lint: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub test: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub build: Option<String>,
}

#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawPaths {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub editable: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub protected: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub generated: Option<Vec<String>>,
}

#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawRole {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub editable: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub forbidden: Option<Vec<String>>,
}

#[derive(Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct RawConstraints {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_tests_for_code_changes: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub forbid_secrets: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_human_review_for_protected_paths: Option<bool>,
}