feat(asc): add json schema cmd and output

This commit adds a command to output a JSON Schema for the applications.yaml file maintained in the komorebi-application-specific-configuration repo, and also adds an up-to-date version of the JSON Schema as a file in the root of this repository so that users can reference it as an autocompletion source.
LGUG2Z · Dec 2, 2023 · 5a99a68 · 5a99a68
1 parent 8980e3b
commit 5a99a68
Show file tree

Hide file tree

Showing 4 changed files with 146 additions and 0 deletions.
diff --git a/komorebi-core/src/lib.rs b/komorebi-core/src/lib.rs
@@ -155,6 +155,7 @@ pub enum SocketMessage {
     ToggleTitleBars,
     AddSubscriber(String),
     RemoveSubscriber(String),
+    ApplicationSpecificConfigurationSchema,
     NotificationSchema,
     SocketSchema,
     StaticConfigSchema,

diff --git a/komorebi/src/process_command.rs b/komorebi/src/process_command.rs
@@ -20,6 +20,7 @@ use parking_lot::Mutex;
 use schemars::schema_for;
 use uds_windows::UnixStream;
 
+use komorebi_core::config_generation::ApplicationConfiguration;
 use komorebi_core::config_generation::IdWithIdentifier;
 use komorebi_core::config_generation::MatchingStrategy;
 use komorebi_core::ApplicationIdentifier;
@@ -1176,6 +1177,14 @@ impl WindowManager {
             SocketMessage::AltFocusHack(enable) => {
                 ALT_FOCUS_HACK.store(enable, Ordering::SeqCst);
             }
+            SocketMessage::ApplicationSpecificConfigurationSchema => {
+                let asc = schema_for!(Vec<ApplicationConfiguration>);
+                let schema = serde_json::to_string_pretty(&asc)?;
+                let socket = DATA_DIR.join("komorebic.sock");
+
+                let mut stream = UnixStream::connect(socket)?;
+                stream.write_all(schema.as_bytes())?;
+            }
             SocketMessage::NotificationSchema => {
                 let notification = schema_for!(Notification);
                 let schema = serde_json::to_string_pretty(&notification)?;

diff --git a/komorebic/src/main.rs b/komorebic/src/main.rs
@@ -1087,6 +1087,9 @@ enum SubCommand {
     /// Fetch the latest version of applications.yaml from komorebi-application-specific-configuration
     #[clap(alias = "fetch-asc")]
     FetchAppSpecificConfiguration,
+    /// Generate a JSON Schema for applications.yaml
+    #[clap(alias = "asc-schema")]
+    ApplicationSpecificConfigurationSchema,
     /// Generate a JSON Schema of subscription notifications
     NotificationSchema,
     /// Generate a JSON Schema of socket messages
@@ -2095,6 +2098,11 @@ Stop-Process -Name:whkd -ErrorAction SilentlyContinue
                output_file.display()
             );
         }
+        SubCommand::ApplicationSpecificConfigurationSchema => {
+            with_komorebic_socket(|| {
+                send_message(&SocketMessage::ApplicationSpecificConfigurationSchema.as_bytes()?)
+            })?;
+        }
         SubCommand::NotificationSchema => {
             with_komorebic_socket(|| send_message(&SocketMessage::NotificationSchema.as_bytes()?))?;
         }

diff --git a/schema.asc.json b/schema.asc.json
@@ -0,0 +1,128 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Array_of_ApplicationConfiguration",
+  "type": "array",
+  "items": {
+    "$ref": "#/definitions/ApplicationConfiguration"
+  },
+  "definitions": {
+    "ApplicationConfiguration": {
+      "type": "object",
+      "required": [
+        "identifier",
+        "name"
+      ],
+      "properties": {
+        "float_identifiers": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/IdWithIdentifierAndComment"
+          }
+        },
+        "identifier": {
+          "$ref": "#/definitions/IdWithIdentifier"
+        },
+        "name": {
+          "type": "string"
+        },
+        "options": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/ApplicationOptions"
+          }
+        }
+      }
+    },
+    "ApplicationIdentifier": {
+      "type": "string",
+      "enum": [
+        "Exe",
+        "Class",
+        "Title"
+      ]
+    },
+    "ApplicationOptions": {
+      "type": "string",
+      "enum": [
+        "object_name_change",
+        "layered",
+        "border_overflow",
+        "tray_and_multi_window",
+        "force"
+      ]
+    },
+    "IdWithIdentifier": {
+      "type": "object",
+      "required": [
+        "id",
+        "kind"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "kind": {
+          "$ref": "#/definitions/ApplicationIdentifier"
+        },
+        "matching_strategy": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/MatchingStrategy"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      }
+    },
+    "IdWithIdentifierAndComment": {
+      "type": "object",
+      "required": [
+        "id",
+        "kind"
+      ],
+      "properties": {
+        "comment": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "id": {
+          "type": "string"
+        },
+        "kind": {
+          "$ref": "#/definitions/ApplicationIdentifier"
+        },
+        "matching_strategy": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/MatchingStrategy"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      }
+    },
+    "MatchingStrategy": {
+      "type": "string",
+      "enum": [
+        "Legacy",
+        "Equals",
+        "StartsWith",
+        "EndsWith",
+        "Contains",
+        "Regex"
+      ]
+    }
+  }
+}