fix: Fix ESLint schema (#3272)

Remove references from schema because ESLint does not support them. fixes: #3269
streetsidesoftware · Jul 23, 2022 · 05bb8ed · 05bb8ed
1 parent a9704d4
commit 05bb8ed
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 27 deletions.
diff --git a/packages/cspell-eslint-plugin/package.json b/packages/cspell-eslint-plugin/package.json
@@ -35,7 +35,7 @@
   "scripts": {
     "build": "npm run build-schema && npm run build-rollup",
     "build-rollup": "rollup --config rollup.config.ts --configPlugin typescript",
-    "build-schema": "ts-json-schema-generator --no-top-ref --path src/options.ts --type Options  -o  ./src/_auto_generated_/options.schema.json",
+    "build-schema": "ts-json-schema-generator --no-top-ref --expose none --path src/options.ts --type Options  -o  ./src/_auto_generated_/options.schema.json",
     "watch": "npm run build-rollup -- --watch",
     "clean": "rimraf dist coverage .tsbuildinfo",
     "clean-build": "npm run clean && npm run build",

diff --git a/packages/cspell-eslint-plugin/src/_auto_generated_/options.schema.json b/packages/cspell-eslint-plugin/src/_auto_generated_/options.schema.json
@@ -1,30 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "additionalProperties": false,
-  "definitions": {
-    "CustomWordListFile": {
-      "additionalProperties": false,
-      "properties": {
-        "addWords": {
-          "description": "**Experimental**: Provide a fix option to add words to the file.\n\nNote: this does not yet work perfectly.",
-          "type": "boolean"
-        },
-        "path": {
-          "$ref": "#/definitions/CustomWordListFilePath",
-          "description": "Path to word list file. File format: 1 word per line"
-        }
-      },
-      "required": [
-        "path",
-        "addWords"
-      ],
-      "type": "object"
-    },
-    "CustomWordListFilePath": {
-      "description": "Specify a path to a custom word list file",
-      "type": "string"
-    }
-  },
+  "definitions": {},
   "properties": {
     "checkComments": {
       "default": true,
@@ -49,10 +26,26 @@
     "customWordListFile": {
       "anyOf": [
         {
-          "$ref": "#/definitions/CustomWordListFilePath"
+          "description": "Specify a path to a custom word list file",
+          "type": "string"
         },
         {
-          "$ref": "#/definitions/CustomWordListFile"
+          "additionalProperties": false,
+          "properties": {
+            "addWords": {
+              "description": "**Experimental**: Provide a fix option to add words to the file.\n\nNote: this does not yet work perfectly.",
+              "type": "boolean"
+            },
+            "path": {
+              "description": "Path to word list file. File format: 1 word per line",
+              "type": "string"
+            }
+          },
+          "required": [
+            "path",
+            "addWords"
+          ],
+          "type": "object"
         }
       ],
       "description": "Specify a path to a custom word list file"