Merge branch 'develop' into deps/dev

Author: rtuszik

README.md

@@ -95,6 +95,31 @@ Explore the demo to see how KoalaKeys works and to get ideas for creating custom
 
 4. Open `index.html` to view the cheat sheet collection.
 
+## Schema
+
+Validate your YAML with the published JSON Schema:
+
+- Public URL: https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json
+- Per-file modeline (first line in each YAML):
+
+    ```
+    # yaml-language-server: $schema=https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json
+    ```
+
+- Neovim yamlls mapping (optional):
+
+    ```lua
+    require('lspconfig').yamlls.setup({
+      settings = {
+        yaml = {
+          schemas = {
+            ["https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json"] = "cheatsheets/*.yaml",
+          },
+        },
+      },
+    })
+    ```
+
 ## Contributing
 
 Contributions are welcome! Feel free to submit issues, feature requests, or pull requests.

docs/schema/cheatsheet.schema.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://rtuszik.github.io/KoalaKeys/schema/cheatsheet.schema.json",
+  "title": "KoalaKeys Cheatsheet",
+  "description": "Schema for KoalaKeys YAML cheatsheets.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["title", "layout", "shortcuts"],
+  "properties": {
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Title of the cheatsheet."
+    },
+    "RenderKeys": {
+      "type": "boolean",
+      "default": true,
+      "description": "When true (default), render keyboard layout with highlighted keys."
+    },
+    "AllowText": {
+      "type": "boolean",
+      "default": false,
+      "description": "When true, free-form shortcut text is allowed; requires RenderKeys=false."
+    },
+    "layout": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["keyboard", "system"],
+      "properties": {
+        "keyboard": {
+          "type": "string",
+          "enum": ["US", "UK", "DE", "FR", "ES", "DVORAK"],
+          "description": "Keyboard layout."
+        },
+        "system": {
+          "type": "string",
+          "enum": ["Darwin", "Windows", "Linux"],
+          "description": "Operating system."
+        }
+      }
+    },
+    "shortcuts": {
+      "type": "object",
+      "minProperties": 1,
+      "description": "Categories mapped to shortcut definitions.",
+      "additionalProperties": {
+        "type": "object",
+        "minProperties": 1
+      }
+    }
+  },
+  "allOf": [
+    {
+      "description": "AllowText=true requires RenderKeys=false.",
+      "if": {
+        "properties": { "AllowText": { "const": true } },
+        "required": ["AllowText"]
+      },
+      "then": {
+        "properties": {
+          "RenderKeys": { "const": false },
+          "shortcuts": {
+            "additionalProperties": {
+              "additionalProperties": { "$ref": "#/$defs/shortcutEntry" }
+            }
+          }
+        }
+      }
+    },
+    {
+      "description": "When AllowText is not true, restrict shortcut key syntax.",
+      "if": {
+        "not": {
+          "properties": { "AllowText": { "const": true } },
+          "required": ["AllowText"]
+        }
+      },
+      "then": {
+        "properties": {
+          "shortcuts": {
+            "additionalProperties": {
+              "type": "object",
+              "minProperties": 1,
+              "patternProperties": {
+                "^[A-Za-z0-9+⌘⌥⌃⇧←→↑↓\\s\\-\\|\\[\\],.:/`\"?<>=\\\\⌃]+$": {
+                  "$ref": "#/$defs/shortcutEntry"
+                }
+              },
+              "additionalProperties": false
+            }
+          }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "shortcutEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["description"],
+      "properties": {
+        "description": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Human-readable description of the shortcut."
+        }
+      },
+      "examples": [
+        { "description": "Copy selected item" }
+      ]
+    }
+  },
+  "examples": [
+    {
+      "title": "KoalaKeys",
+      "RenderKeys": true,
+      "AllowText": false,
+      "layout": { "keyboard": "US", "system": "Darwin" },
+      "shortcuts": {
+        "General": {
+          "CMD+C": { "description": "Copy selected item" },
+          "CMD+Right": { "description": "Move cursor to end of line" }
+        }
+      }
+    }
+  ]
+}

src/validate_yaml.py

@@ -56,8 +56,8 @@ def validate_layout(data):
         logger.error("Layout must be a dictionary")
         return False
 
-    valid_keyboards = ["US", "UK", "DE", "FR", "ES"]
-    valid_systems = ["Darwin", "Linux", "Windows"]
+    valid_keyboards = ['US', 'UK', 'DE', 'FR', 'ES', 'DVORAK']
+    valid_systems = ['Darwin', 'Linux', 'Windows']
     is_valid = True
 
     if "keyboard" in data["layout"] and data["layout"]["keyboard"] not in valid_keyboards:

yaml_cheatsheet_spec.md

@@ -61,6 +61,7 @@ Valid values for `keyboard` are:
 - `DE` (German)
 - `FR` (French)
 - `ES` (Spanish)
+- `DVORAK`
 
 ### System Types