Merge pull request #1169 from cachix/json-schema

add devenv.schema.json

.github/workflows/generate.yml

@@ -33,6 +33,8 @@ jobs:
       run: devenv shell devenv-generate-languages-example
     - name: Generate docs
       run: devenv shell devenv-generate-docs
+    - name: Generate JSON schema
+      run: devenv generate-json-schema
     - uses: EndBug/add-and-commit@v9
       if: ${{ github.event_name == 'push' }}
       with:

devenv.yaml

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=./docs/devenv.schema.json
 inputs:
   devenv:
     url: path:.?dir=src/modules

devenv/Cargo.toml

@@ -29,3 +29,4 @@ whoami = "1.5.1"
 xdg = "2.5.2"
 
 devenv_core = { path = "../devenv_core" }
+schemars = "0.8.16"

devenv/init/devenv.yaml

@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://devenv.sh/devenv.schema.json
 inputs:
   nixpkgs:
     url: github:cachix/devenv-nixpkgs/rolling

devenv/src/config.rs

@@ -1,11 +1,12 @@
 use miette::{IntoDiagnostic, Result};
-use schematic::{schema::JsonSchemaRenderer, schema::SchemaGenerator, ConfigLoader};
+use schemars::{schema_for, JsonSchema};
+use schematic::ConfigLoader;
 use serde::{Deserialize, Serialize};
 use std::{collections::HashMap, path::Path};
 
 const YAML_CONFIG: &str = "devenv.yaml";
 
-#[derive(schematic::Config, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(schematic::Config, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[config(rename_all = "camelCase")]
 #[serde(rename_all = "camelCase")]
 pub struct Input {
@@ -34,7 +35,7 @@ impl Input {
     }
 }
 
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Debug, JsonSchema)]
 pub struct FlakeInput {
     pub url: Option<String>,
     pub inputs: HashMap<String, Input>,
@@ -66,14 +67,14 @@ fn is_false(b: &bool) -> bool {
     !*b
 }
 
-#[derive(schematic::Config, Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(schematic::Config, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct Clean {
     pub enabled: bool,
     pub keep: Vec<String>,
     // TODO: executables?
 }
 
-#[derive(schematic::Config, Clone, Serialize, Debug)]
+#[derive(schematic::Config, Clone, Serialize, Debug, JsonSchema)]
 #[config(rename_all = "camelCase")]
 #[serde(rename_all = "camelCase")]
 pub struct Config {
@@ -88,19 +89,20 @@ pub struct Config {
     pub imports: Vec<String>,
     #[serde(skip_serializing_if = "Vec::is_empty", default)]
     pub permitted_insecure_packages: Vec<String>,
-    #[serde(skip_serializing_if = "Option::is_none", default = "std::option::None")]
     #[setting(nested)]
+    #[serde(skip_serializing_if = "Option::is_none", default)]
     pub clean: Option<Clean>,
     #[serde(skip_serializing_if = "is_false", default = "false_default")]
     pub impure: bool,
 }
 
+// TODO: https://github.com/moonrepo/schematic/issues/105
 pub fn write_json_schema() {
-    let mut generator = SchemaGenerator::default();
-    generator.add::<Config>();
-    generator
-        .generate("devenv.schema.json", JsonSchemaRenderer::default())
-        .expect("can't generate schema");
+    let schema = schema_for!(Config);
+    let schema = serde_json::to_string_pretty(&schema).unwrap();
+    let path = Path::new("docs/devenv.schema.json");
+    std::fs::write(path, schema)
+        .unwrap_or_else(|_| panic!("Failed to write json schema to {}", path.display()));
 }
 
 impl Config {

docs/devenv.schema.json

@@ -0,0 +1,96 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Config",
+  "type": "object",
+  "properties": {
+    "allowBroken": {
+      "type": "boolean"
+    },
+    "allowUnfree": {
+      "type": "boolean"
+    },
+    "clean": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Clean"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "imports": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "impure": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/Input"
+      }
+    },
+    "permittedInsecurePackages": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "definitions": {
+    "Clean": {
+      "type": "object",
+      "required": [
+        "enabled",
+        "keep"
+      ],
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "keep": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Input": {
+      "type": "object",
+      "properties": {
+        "flake": {
+          "type": "boolean"
+        },
+        "follows": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "inputs": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/Input"
+          }
+        },
+        "overlays": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "url": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    }
+  }
+}