@cspell/eslint-plugin 6.4.0-alpha.0 → 6.4.2

package/dist/index.d.ts

@@ -78,10 +78,26 @@ interface Check {
      */
     checkComments?: boolean;
     /**
-     * **Experimental**: Specify a path to a custom word list file. A utf-8 text file with one word per line.
-     * This file is used to present the option to add words.
+     * Specify a path to a custom word list file
      */
-    customWordListFile?: string | undefined;
+    customWordListFile?: CustomWordListFilePath | CustomWordListFile | undefined;
+}
+/**
+ * Specify a path to a custom word list file
+ */
+declare type CustomWordListFilePath = string;
+interface CustomWordListFile {
+    /**
+     * Path to word list file.
+     * File format: 1 word per line
+     */
+    path: CustomWordListFilePath;
+    /**
+     * **Experimental**: Provide a fix option to add words to the file.
+     *
+     * Note: this does not yet work perfectly.
+     */
+    addWords: boolean;
 }
 
 export { Options, configs, rules };

package/dist/index.js

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v6.3.0
+ * @cspell/eslint-plugin v6.4.1
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -120,8 +120,31 @@ var properties = {
 		type: "boolean"
 	},
 	customWordListFile: {
-		description: "**Experimental**: Specify a path to a custom word list file. A utf-8 text file with one word per line. This file is used to present the option to add words.",
-		type: "string"
+		anyOf: [
+			{
+				description: "Specify a path to a custom word list file",
+				type: "string"
+			},
+			{
+				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"
 	},
 	debugMode: {
 		"default": false,
@@ -336,9 +359,10 @@ function create(context) {
             };
         }
         function createAddWordToDictionaryFix(word) {
-            if (!options.customWordListFile)
+            if (!isCustomWordListFile(options.customWordListFile) || !options.customWordListFile.addWords) {
                 return undefined;
-            const dictFile = path__namespace.resolve(context.getCwd(), options.customWordListFile);
+            }
+            const dictFile = path__namespace.resolve(context.getCwd(), options.customWordListFile.path);
             const data = { word, dictionary: path__namespace.basename(dictFile) };
             const messageId = 'addWordToDictionary';
             return {
@@ -533,9 +557,11 @@ function getDocValidator(context) {
     return validator;
 }
 function calcInitialSettings(options, cwd) {
-    if (!options.customWordListFile)
+    const { customWordListFile } = options;
+    if (!customWordListFile)
         return defaultSettings;
-    const dictFile = path__namespace.resolve(cwd, options.customWordListFile);
+    const filePath = isCustomWordListFile(customWordListFile) ? customWordListFile.path : customWordListFile;
+    const dictFile = path__namespace.resolve(cwd, filePath);
     const settings = {
         ...defaultSettings,
         dictionaryDefinitions: [{ name: 'eslint-plugin-custom-words', path: dictFile }],
@@ -578,6 +604,9 @@ class WrapFix {
         return this.fix.text;
     }
 }
+function isCustomWordListFile(value) {
+    return !!value && typeof value === 'object';
+}
 
 exports.configs = configs;
 exports.rules = rules;

package/dist/index.mjs

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v6.3.0
+ * @cspell/eslint-plugin v6.4.1
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -92,8 +92,31 @@ var properties = {
 		type: "boolean"
 	},
 	customWordListFile: {
-		description: "**Experimental**: Specify a path to a custom word list file. A utf-8 text file with one word per line. This file is used to present the option to add words.",
-		type: "string"
+		anyOf: [
+			{
+				description: "Specify a path to a custom word list file",
+				type: "string"
+			},
+			{
+				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"
 	},
 	debugMode: {
 		"default": false,
@@ -308,9 +331,10 @@ function create(context) {
             };
         }
         function createAddWordToDictionaryFix(word) {
-            if (!options.customWordListFile)
+            if (!isCustomWordListFile(options.customWordListFile) || !options.customWordListFile.addWords) {
                 return undefined;
-            const dictFile = path.resolve(context.getCwd(), options.customWordListFile);
+            }
+            const dictFile = path.resolve(context.getCwd(), options.customWordListFile.path);
             const data = { word, dictionary: path.basename(dictFile) };
             const messageId = 'addWordToDictionary';
             return {
@@ -505,9 +529,11 @@ function getDocValidator(context) {
     return validator;
 }
 function calcInitialSettings(options, cwd) {
-    if (!options.customWordListFile)
+    const { customWordListFile } = options;
+    if (!customWordListFile)
         return defaultSettings;
-    const dictFile = path.resolve(cwd, options.customWordListFile);
+    const filePath = isCustomWordListFile(customWordListFile) ? customWordListFile.path : customWordListFile;
+    const dictFile = path.resolve(cwd, filePath);
     const settings = {
         ...defaultSettings,
         dictionaryDefinitions: [{ name: 'eslint-plugin-custom-words', path: dictFile }],
@@ -550,6 +576,9 @@ class WrapFix {
         return this.fix.text;
     }
 }
+function isCustomWordListFile(value) {
+    return !!value && typeof value === 'object';
+}
 
 export { configs, rules };
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.4.0-alpha.0",
+  "version": "6.4.2",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -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",
@@ -59,11 +59,11 @@
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^8.3.3",
     "@types/eslint": "^8.4.5",
-    "@types/estree": "^0.0.52",
-    "@types/node": "^18.0.6",
-    "@typescript-eslint/parser": "^5.30.6",
-    "@typescript-eslint/types": "^5.30.6",
-    "@typescript-eslint/typescript-estree": "^5.30.6",
+    "@types/estree": "^1.0.0",
+    "@types/node": "^18.6.1",
+    "@typescript-eslint/parser": "^5.31.0",
+    "@typescript-eslint/types": "^5.31.0",
+    "@typescript-eslint/typescript-estree": "^5.31.0",
     "eslint": "^8.20.0",
     "mocha": "^10.0.0",
     "rimraf": "^3.0.2",
@@ -72,7 +72,7 @@
     "ts-json-schema-generator": "^1.0.0"
   },
   "dependencies": {
-    "cspell-lib": "^6.4.0-alpha.0"
+    "cspell-lib": "^6.4.2"
   },
-  "gitHead": "ad84fb5398b1f9c1133187616637efe2f13ea598"
+  "gitHead": "1f7481fd7d6a561de92ba49870da6eb1441a9d20"
 }