Merge pull request #536 from Shopify/feature/better-input-settings-docs

Add config/settings_schema.json JSON schema
Shopify · Apr 9, 2024 · ee941ec · ee941ec
2 parents 18bad38 + 3be3533
commit ee941ec
Show file tree

Hide file tree

Showing 14 changed files with 3,244 additions and 424 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,22 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": [
+        "tests/fixtures/section-*.json"
+      ],
+      "url": "./schemas/theme/section.json"
+    },
+    {
+      "fileMatch": [
+        "tests/fixtures/translations-*.json"
+      ],
+      "url": "./schemas/theme/translations.json"
+    },
+    {
+      "fileMatch": [
+        "tests/fixtures/theme-settings-*.json"
+      ],
+      "url": "./schemas/theme/theme_settings.json"
+    }
+  ]
+}
diff --git a/schemas/manifest_theme.json b/schemas/manifest_theme.json
@@ -11,7 +11,14 @@
       "fileMatch": ["sections/*.liquid"]
     },
     {
-      "uri": "theme/input_settings.json"
+      "uri": "theme/theme_settings.json",
+      "fileMatch": ["config/settings_schema.json"]
+    },
+    {
+      "uri": "theme/settings.json"
+    },
+    {
+      "uri": "theme/setting.json"
     }
   ]
 }
diff --git a/schemas/theme/input_settings.json b/schemas/theme/input_settings.json
diff --git a/schemas/theme/section.json b/schemas/theme/section.json
@@ -25,8 +25,7 @@
       "maximum": 2
     },
     "settings": {
-      "description": "Section specific settings.",
-      "$ref": "./input_settings.json"
+      "$ref": "./settings.json"
     },
     "max_blocks": {
       "type": "integer",
@@ -49,8 +48,7 @@
             "description": "The block type."
           },
           "settings": {
-            "description": "Block settings.",
-            "$ref": "./input_settings.json"
+            "$ref": "./settings.json"
           }
         },
         "if": {