fix(core): Make JSON Schemas at packages/core/src/ruleset/meta valid

Plus add a GitHub Action that uses `sourcemeta/jsonschema` to perform some basic smoke tests to prevent regressions. Fixes: #2787 Signed-off-by: Juan Cruz Viotti <[email protected]>
stoplightio · Feb 25, 2025 · cdeb563 · cdeb563
1 parent cb7792c
commit cdeb563
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 11 deletions.
diff --git a/.github/workflows/jsonschema.yml b/.github/workflows/jsonschema.yml
@@ -0,0 +1,23 @@
+name: Check JSON Schemas
+
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  jsonschema-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@main
+    - uses: sourcemeta/[email protected]
+    - run: jsonschema metaschema --verbose packages/core/src/ruleset/meta/*.json
+    - run: jsonschema lint --verbose packages/core/src/ruleset/meta/*.json
+
+    # As a smoke test to ensure the schemas at least reference each other well 
+    - run: >
+        jsonschema bundle --verbose 
+        packages/core/src/ruleset/meta/ruleset.schema.json 
+        --resolve packages/core/src/ruleset/meta 
+        --ignore packages/core/src/ruleset/meta/js-extensions.json
diff --git a/packages/core/src/ruleset/meta/js-extensions.json b/packages/core/src/ruleset/meta/js-extensions.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "@stoplight/spectral-core/meta/extensions",
   "$defs": {
     "Extends": {
@@ -20,13 +20,12 @@
               {
                 "type": "array",
                 "minItems": 2,
-                "additionalItems": false,
-                "items": [
+                "items": false,
+                "prefixItems": [
                   {
                     "$ref": "ruleset"
                   },
                   {
-                    "type": "string",
                     "enum": ["off", "recommended", "all"],
                     "errorMessage": "allowed types are \"off\", \"recommended\" and \"all\""
                   }

diff --git a/packages/core/src/ruleset/meta/json-extensions.json b/packages/core/src/ruleset/meta/json-extensions.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "@stoplight/spectral-core/meta/extensions",
   "$defs": {
     "Extends": {
@@ -18,8 +18,8 @@
               {
                 "type": "array",
                 "minItems": 2,
-                "additionalItems": false,
-                "items": [
+                "items": false,
+                "prefixItems": [
                   {
                     "type": "string"
                   },

diff --git a/packages/core/src/ruleset/meta/rule.schema.json b/packages/core/src/ruleset/meta/rule.schema.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "@stoplight/spectral-core/meta/rule.schema",
   "$defs": {
     "Then": {
@@ -75,7 +75,6 @@
       },
       "type": {
         "enum": ["style", "validation"],
-        "type": "string",
         "errorMessage": "allowed types are \"style\" and \"validation\""
       },
       "extensions": {

diff --git a/packages/core/src/ruleset/meta/ruleset.schema.json b/packages/core/src/ruleset/meta/ruleset.schema.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "@stoplight/spectral-core/meta/ruleset.schema",
   "type": "object",
   "additionalProperties": false,

diff --git a/packages/core/src/ruleset/meta/shared.json b/packages/core/src/ruleset/meta/shared.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "@stoplight/spectral-core/meta/shared",
   "$defs": {
     "Formats": {