fallow_api/
schemas.rs

1//! JSON Schema documents and zero-config rule defaults, re-exported from
2//! `fallow-config` for embedders that must not depend on the config crate
3//! directly (the MCP server's `fallow://schema/*` and `fallow://issue-types`
4//! resources). Each function returns the exact document the matching CLI
5//! command prints (`fallow config-schema`, `fallow plugin-schema`,
6//! `fallow rule-pack-schema`), so a cached resource and a CLI dump agree.
7
8use std::sync::LazyLock;
9
10use fallow_config::{ExternalPluginDef, FallowConfig, RulePackDef, RulesConfig};
11
12/// `RulesConfig::default()` serialized once; the struct is compile-time
13/// constant, so the map never changes within a process.
14static DEFAULT_RULE_SEVERITIES: LazyLock<serde_json::Value> = LazyLock::new(|| {
15    serde_json::to_value(RulesConfig::default())
16        .unwrap_or_else(|_| serde_json::Value::Object(serde_json::Map::new()))
17});
18
19/// JSON Schema of the fallow config file (`fallow config-schema`).
20#[must_use]
21pub fn config_schema() -> serde_json::Value {
22    FallowConfig::json_schema()
23}
24
25/// JSON Schema of a user-authored external plugin (`fallow plugin-schema`).
26#[must_use]
27pub fn plugin_schema() -> serde_json::Value {
28    ExternalPluginDef::json_schema()
29}
30
31/// JSON Schema of a declarative rule pack (`fallow rule-pack-schema`).
32#[must_use]
33pub fn rule_pack_schema() -> serde_json::Value {
34    RulePackDef::json_schema()
35}
36
37/// Committed copy of the derived snapshot schema. The copy keeps the `schema`
38/// feature (and its `JsonSchema` derives) out of embedders such as the MCP
39/// server. `fallow-schema-emit --similar-code-snapshot` regenerates it, and
40/// the schema-emit drift test compares it with the derive.
41const SIMILAR_CODE_SNAPSHOT_SCHEMA_JSON: &str =
42    include_str!("../similar-code-snapshot-schema.json");
43
44static SIMILAR_CODE_SNAPSHOT_SCHEMA: LazyLock<serde_json::Value> = LazyLock::new(|| {
45    serde_json::from_str(SIMILAR_CODE_SNAPSHOT_SCHEMA_JSON)
46        .unwrap_or_else(|_| serde_json::Value::Object(serde_json::Map::new()))
47});
48
49/// JSON Schema of the `inspect_similar_code` candidate snapshot handoff, the
50/// object `find_similar_code` hands back and `inspect` reads from stdin.
51#[must_use]
52pub fn similar_code_snapshot_schema() -> serde_json::Value {
53    SIMILAR_CODE_SNAPSHOT_SCHEMA.clone()
54}
55
56/// The zero-config `rules.*` severities as a flat JSON object keyed by config
57/// key (`unused-exports`, `security-sink`, ...), serialized once from
58/// `RulesConfig::default()`. This is the single source of default severities
59/// for `fallow schema` and the MCP issue-type resource. Infallible in
60/// practice (a flat struct of `Severity` enums); the empty-object fallback
61/// keeps callers panic-free and simply yields no default severity if
62/// serialization ever changed shape.
63#[must_use]
64pub fn default_rule_severities() -> serde_json::Value {
65    DEFAULT_RULE_SEVERITIES.clone()
66}
67
68/// Whether `key` names a `rules.*` config field (a kebab-case key of
69/// [`default_rule_severities`]).
70#[must_use]
71pub fn is_rule_severity_key(key: &str) -> bool {
72    DEFAULT_RULE_SEVERITIES
73        .get(key)
74        .is_some_and(serde_json::Value::is_string)
75}
76
77#[cfg(test)]
78mod tests {
79    use super::*;
80
81    #[test]
82    fn schemas_are_json_objects_with_properties() {
83        for (label, schema) in [
84            ("config", config_schema()),
85            ("plugin", plugin_schema()),
86            ("rule-pack", rule_pack_schema()),
87        ] {
88            assert!(
89                schema
90                    .get("properties")
91                    .is_some_and(serde_json::Value::is_object),
92                "{label} schema must be an object schema with properties"
93            );
94        }
95    }
96
97    #[test]
98    fn default_severities_are_keyed_by_config_key() {
99        let defaults = default_rule_severities();
100        assert_eq!(defaults["unused-exports"], "error");
101        assert_eq!(defaults["security-sink"], "off");
102        assert!(
103            defaults.get("unused_exports").is_none(),
104            "keys are kebab-case"
105        );
106        assert!(is_rule_severity_key("coverage-gaps"));
107        assert!(!is_rule_severity_key("code-duplication"));
108    }
109}
fallow_api/schemas.rs

fallow_api/
schemas.rs
