Merge pull request #51 from dev-five-git/add-config-schema

Add config schema

Author: owjs3901

Cargo.lock

@@ -11,6 +11,7 @@ description = "Manages models/migrations directories and naming-case preferences
 [dependencies]
 serde = { version = "1", features = ["derive"] }
 clap = { version = "4", features = ["derive"] }
+schemars = "1.1"
 
 [dev-dependencies]
 serde_json = "1"

crates/vespertide-config/Cargo.toml

@@ -1,5 +1,6 @@
 use std::path::{Path, PathBuf};
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::file_format::FileFormat;
@@ -11,7 +12,7 @@ pub fn default_migration_filename_pattern() -> String {
 }
 
 /// SeaORM-specific export configuration.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct SeaOrmConfig {
     /// Additional derive macros to add to generated enum types.
@@ -49,7 +50,7 @@ impl SeaOrmConfig {
 }
 
 /// Top-level vespertide configuration.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct VespertideConfig {
     pub models_dir: PathBuf,

crates/vespertide-config/src/config.rs

@@ -1,8 +1,9 @@
 use clap::ValueEnum;
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// Supported file formats for generated artifacts.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ValueEnum)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ValueEnum, JsonSchema)]
 #[serde(rename_all = "lowercase")]
 #[derive(Default)]
 pub enum FileFormat {

crates/vespertide-config/src/file_format.rs

@@ -1,7 +1,8 @@
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// Supported naming cases.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all = "snake_case")]
 pub enum NameCase {
     Snake,

crates/vespertide-config/src/name_case.rs

@@ -1,23 +1,24 @@
-[package]
-name = "vespertide-schema-gen"
-version = "0.1.0"
-edition.workspace = true
-license.workspace = true
-repository.workspace = true
-homepage.workspace = true
-documentation.workspace = true
-description = "Emits JSON Schemas for vespertide models and migrations"
-publish = false
-
+[package]
+name = "vespertide-schema-gen"
+version = "0.1.0"
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+homepage.workspace = true
+documentation.workspace = true
+description = "Emits JSON Schemas for vespertide models and migrations"
+publish = false
+
 [dependencies]
 anyhow = "1"
 clap = { version = "4", features = ["derive"] }
 schemars = "1.1"
 serde_json = "1"
 vespertide-core = { workspace = true }
-
-[dev-dependencies]
-tempfile = "3"
-assert_cmd = "2"
-predicates = "3"
-
+vespertide-config = { workspace = true }
+
+[dev-dependencies]
+tempfile = "3"
+assert_cmd = "2"
+predicates = "3"
+

crates/vespertide-schema-gen/Cargo.toml

@@ -4,6 +4,7 @@ use std::path::PathBuf;
 use anyhow::{Context, Result};
 use clap::Parser;
 use schemars::schema_for;
+use vespertide_config::VespertideConfig;
 use vespertide_core::{MigrationPlan, TableDef};
 
 #[derive(Debug, Parser)]
@@ -29,9 +30,11 @@ fn run(out: PathBuf) -> Result<()> {
 
     let model_schema = schema_for!(TableDef);
     let migration_schema = schema_for!(MigrationPlan);
+    let config_schema = schema_for!(VespertideConfig);
 
     let model_path = out.join("model.schema.json");
     let migration_path = out.join("migration.schema.json");
+    let config_path = out.join("config.schema.json");
 
     fs::write(
         &model_path,
@@ -45,9 +48,16 @@ fn run(out: PathBuf) -> Result<()> {
     )
     .with_context(|| format!("write {}", migration_path.display()))?;
 
+    fs::write(
+        &config_path,
+        serde_json::to_string_pretty(&config_schema).context("serialize config schema")?,
+    )
+    .with_context(|| format!("write {}", config_path.display()))?;
+
     println!("Wrote schemas:");
     println!("  {}", model_path.display());
     println!("  {}", migration_path.display());
+    println!("  {}", config_path.display());
     Ok(())
 }
 
@@ -98,24 +108,28 @@ mod tests {
     }
 
     #[test]
-    fn run_generates_both_schema_files() {
+    fn run_generates_all_schema_files() {
         let temp_dir = TempDir::new().unwrap();
         let out = temp_dir.path();
 
         run(out.to_path_buf()).unwrap();
 
         let model_path = out.join("model.schema.json");
         let migration_path = out.join("migration.schema.json");
+        let config_path = out.join("config.schema.json");
 
         assert!(model_path.exists());
         assert!(migration_path.exists());
+        assert!(config_path.exists());
 
         // Verify files are valid JSON
         let model_content = fs::read_to_string(&model_path).unwrap();
         let migration_content = fs::read_to_string(&migration_path).unwrap();
+        let config_content = fs::read_to_string(&config_path).unwrap();
 
         serde_json::from_str::<serde_json::Value>(&model_content).unwrap();
         serde_json::from_str::<serde_json::Value>(&migration_content).unwrap();
+        serde_json::from_str::<serde_json::Value>(&config_content).unwrap();
     }
 
     #[test]
@@ -132,7 +146,25 @@ mod tests {
 
         let model_path = out.join("model.schema.json");
         let migration_path = out.join("migration.schema.json");
+        let config_path = out.join("config.schema.json");
         assert!(model_path.exists());
         assert!(migration_path.exists());
+        assert!(config_path.exists());
+    }
+
+    #[test]
+    fn run_generates_config_schema_file() {
+        let temp_dir = TempDir::new().unwrap();
+        let out = temp_dir.path();
+
+        run(out.to_path_buf()).unwrap();
+
+        let config_path = out.join("config.schema.json");
+        assert!(config_path.exists());
+
+        let content = fs::read_to_string(&config_path).unwrap();
+        assert!(content.contains("VespertideConfig"));
+        assert!(content.contains("modelsDir"));
+        assert!(content.contains("migrationsDir"));
     }
 }

crates/vespertide-schema-gen/src/main.rs

@@ -0,0 +1,97 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "VespertideConfig",
+  "description": "Top-level vespertide configuration.",
+  "type": "object",
+  "properties": {
+    "columnNamingCase": {
+      "$ref": "#/$defs/NameCase"
+    },
+    "migrationFilenamePattern": {
+      "type": "string",
+      "default": "%04v_%m"
+    },
+    "migrationFormat": {
+      "$ref": "#/$defs/FileFormat",
+      "default": "json"
+    },
+    "migrationsDir": {
+      "type": "string"
+    },
+    "modelExportDir": {
+      "description": "Output directory for generated ORM models.",
+      "type": "string",
+      "default": "src/models"
+    },
+    "modelFormat": {
+      "$ref": "#/$defs/FileFormat",
+      "default": "json"
+    },
+    "modelsDir": {
+      "type": "string"
+    },
+    "seaorm": {
+      "description": "SeaORM-specific export configuration.",
+      "$ref": "#/$defs/SeaOrmConfig",
+      "default": {
+        "extraEnumDerives": [
+          "vespera::Schema"
+        ],
+        "extraModelDerives": []
+      }
+    },
+    "tableNamingCase": {
+      "$ref": "#/$defs/NameCase"
+    }
+  },
+  "required": [
+    "modelsDir",
+    "migrationsDir",
+    "tableNamingCase",
+    "columnNamingCase"
+  ],
+  "$defs": {
+    "FileFormat": {
+      "description": "Supported file formats for generated artifacts.",
+      "type": "string",
+      "enum": [
+        "json",
+        "yaml",
+        "yml"
+      ]
+    },
+    "NameCase": {
+      "description": "Supported naming cases.",
+      "type": "string",
+      "enum": [
+        "snake",
+        "camel",
+        "pascal"
+      ]
+    },
+    "SeaOrmConfig": {
+      "description": "SeaORM-specific export configuration.",
+      "type": "object",
+      "properties": {
+        "extraEnumDerives": {
+          "description": "Additional derive macros to add to generated enum types.\nDefault: `[\"vespera::Schema\"]`",
+          "type": "array",
+          "default": [
+            "vespera::Schema"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "extraModelDerives": {
+          "description": "Additional derive macros to add to generated entity model types.",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}