generate schema for all manifests

Author: raymondk

.github/workflows/checks.yml

@@ -160,7 +160,7 @@ jobs:
       - name: Check for uncommitted changes
         run: |
           if [[ -n "$(git status --porcelain)" ]]; then
-            echo "❌ The icp.yaml schema is not up to date"
+            echo "❌ The schema docs are not up to date"
             echo ""
             echo " Run ./scripts/generate-config-schema.sh to update them"
             echo ""

crates/schema-gen/src/main.rs

@@ -1,38 +1,52 @@
-use icp::manifest::project::ProjectManifest;
-use schemars::schema_for;
-
-const ID: &str = "https://dfinity.org/schemas/icp-yaml/v1.0.0";
-const TITLE: &str = "ICP Project Configuration";
-const DESCRIPTION: &str = "Schema for icp.yaml project configuration files used by the ICP CLI";
-
-/// Generate JSON Schema for icp.yaml configuration files
-fn main() -> Result<(), Box<dyn std::error::Error>> {
-    // Generate schema for the main ProjectManifest type
-    let schema = schema_for!(ProjectManifest);
-
-    // Add metadata to the schema
-    let mut schema_json = serde_json::to_value(schema)?;
-
-    // Add custom schema metadata
-    if let Some(schema_obj) = schema_json.as_object_mut() {
-        schema_obj.insert(
-            "$id".to_string(),                         // k
-            serde_json::Value::String(ID.to_string()), // v
-        );
-
-        schema_obj.insert(
-            "title".to_string(),
-            serde_json::Value::String(TITLE.to_string()),
-        );
-
-        schema_obj.insert(
-            "description".to_string(),
-            serde_json::Value::String(DESCRIPTION.to_string()),
-        );
-    }
-
-    // Pretty print the JSON schema to stdout
-    println!("{}", serde_json::to_string_pretty(&schema_json)?);
-
-    Ok(())
+use icp::manifest::{
+    CanisterManifest, EnvironmentManifest, NetworkManifest, project::ProjectManifest,
+};
+
+macro_rules! generate_schemas {
+    ($base:expr, $($t:ty => $filename:expr),+ $(,)?) => {{
+        let base : icp::prelude::PathBuf = $base.into();
+
+        $(
+            {
+                let schema = schemars::schema_for!($t);
+                let mut schema_json = serde_json::to_value(&schema).unwrap();
+
+                if let Some(obj) = schema_json.as_object_mut() {
+                    obj.insert("$id".to_string(), serde_json::Value::String(stringify!($t).to_string()));
+                    obj.insert("title".to_string(), serde_json::Value::String(stringify!($t).to_string()));
+                    obj.insert(
+                        "description".to_string(),
+                        serde_json::Value::String(format!("Schema for {}", stringify!($t))),
+                    );
+                }
+
+                // Build the full path: base + filename
+                let path = base.join($filename);
+                if let Some(parent) = path.parent() {
+                    std::fs::create_dir_all(parent).expect("failed to create parent directories");
+                }
+
+                let pretty = serde_json::to_string_pretty(&schema_json).unwrap();
+                std::fs::write(&path, pretty).expect("failed to write schema file");
+
+                println!("✅ Wrote {} to {}", stringify!($t), path.to_string());
+            }
+        )+
+    }};
+}
+
+fn main() {
+    // Take the base directory as the first command-line argument
+    let base = std::env::args().nth(1).unwrap_or_else(|| {
+        eprintln!("Usage: cargo run -- <base-path>");
+        std::process::exit(1);
+    });
+
+    generate_schemas!(
+        &base,
+        ProjectManifest => "icp-yaml-schema.json",
+        CanisterManifest => "canister-yaml-schema.json",
+        NetworkManifest => "network-yaml-schema.json",
+        EnvironmentManifest => "environment-yaml-schema.json",
+    );
 }