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

package/dist/index.d.ts

@@ -77,6 +77,27 @@ interface Check {
      * @default true
      */
     checkComments?: boolean;
+    /**
+     * Specify a path to a custom word list file
+     */
+    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.2.3
+ * @cspell/eslint-plugin v6.4.0-alpha.0
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -11,19 +11,77 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var assert = require('assert');
 var cspellLib = require('cspell-lib');
+var path = require('path');
 var util = require('util');
+var fs = require('fs');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
 var assert__default = /*#__PURE__*/_interopDefaultLegacy(assert);
+var path__namespace = /*#__PURE__*/_interopNamespace(path);
+var fs__namespace = /*#__PURE__*/_interopNamespace(fs);
+
+const sortFn = new Intl.Collator().compare;
+function addWordToCustomWordList(customWordListPath, word) {
+    const content = readFile(customWordListPath) || '\n';
+    const lineEndingMatch = content.match(/\r?\n/);
+    const lineEnding = (lineEndingMatch === null || lineEndingMatch === void 0 ? void 0 : lineEndingMatch[0]) || '\n';
+    const words = new Set(content
+        .split(/\n/g)
+        .map((a) => a.trim())
+        .filter((a) => !!a));
+    words.add(word);
+    const lines = [...words];
+    lines.sort(sortFn);
+    writeFile(customWordListPath, lines.join(lineEnding) + lineEnding);
+}
+function readFile(file) {
+    try {
+        return fs__namespace.readFileSync(file, 'utf-8');
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+function writeFile(file, content) {
+    makeDir(path__namespace.dirname(file));
+    fs__namespace.writeFileSync(file, content);
+}
+function makeDir(dir) {
+    try {
+        fs__namespace.mkdirSync(dir, { recursive: true });
+    }
+    catch (e) {
+        console.log(e);
+    }
+}
 
 const defaultCheckOptions = {
     checkComments: true,
     checkIdentifiers: true,
     checkStrings: true,
     checkStringTemplates: true,
-    ignoreImports: true,
+    customWordListFile: undefined,
     ignoreImportProperties: true,
+    ignoreImports: true,
 };
 const defaultOptions = {
     ...defaultCheckOptions,
@@ -39,6 +97,28 @@ function normalizeOptions(opts) {
 var $schema = "http://json-schema.org/draft-07/schema#";
 var additionalProperties = false;
 var 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"
+	}
 };
 var properties = {
 	checkComments: {
@@ -61,6 +141,17 @@ var properties = {
 		description: "Spell check strings",
 		type: "boolean"
 	},
+	customWordListFile: {
+		anyOf: [
+			{
+				$ref: "#/definitions/CustomWordListFilePath"
+			},
+			{
+				$ref: "#/definitions/CustomWordListFile"
+			}
+		],
+		description: "Specify a path to a custom word list file"
+	},
 	debugMode: {
 		"default": false,
 		description: "Output debug logs",
@@ -106,6 +197,7 @@ const messages = {
     wordUnknown: 'Unknown word: "{{word}}"',
     wordForbidden: 'Forbidden word: "{{word}}"',
     suggestWord: '{{word}}',
+    addWordToDictionary: 'Add "{{word}}" to {{dictionary}}',
 };
 const meta = {
     docs: {
@@ -157,7 +249,6 @@ function create(context) {
         if (!options.checkStringTemplates)
             return;
         debugNode(node, node.value);
-        // console.log('Template: %o', node.value);
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
@@ -273,8 +364,31 @@ function create(context) {
                 fix: fixFactory(word),
             };
         }
+        function createAddWordToDictionaryFix(word) {
+            if (!isCustomWordListFile(options.customWordListFile) || !options.customWordListFile.addWords) {
+                return undefined;
+            }
+            const dictFile = path__namespace.resolve(context.getCwd(), options.customWordListFile.path);
+            const data = { word, dictionary: path__namespace.basename(dictFile) };
+            const messageId = 'addWordToDictionary';
+            return {
+                messageId,
+                data,
+                fix: (_fixer) => {
+                    // This wrapper is a hack to delay applying the fix until it is actually used.
+                    // But it is not reliable, since ESLint + extension will randomly read the value.
+                    return new WrapFix({ range: [start, end], text: word }, () => {
+                        cspellLib.refreshDictionaryCache(0);
+                        addWordToCustomWordList(dictFile, word);
+                        validator.updateDocumentText(context.getSourceCode().getText());
+                    });
+                },
+            };
+        }
         log('Suggestions: %o', issue.suggestions);
-        const suggest = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
+        const suggestions = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
+        const addWordFix = createAddWordToDictionaryFix(issue.text);
+        const suggest = suggestions || addWordFix ? (suggestions || []).concat(addWordFix ? [addWordFix] : []) : undefined;
         const des = {
             messageId,
             data,
@@ -436,26 +550,69 @@ function getDocValidator(context) {
     const doc = getTextDocument(context.getFilename(), text);
     const cachedValidator = docValCache.get(doc);
     if (cachedValidator) {
+        cspellLib.refreshDictionaryCache(0);
         cachedValidator.updateDocumentText(text);
         return cachedValidator;
     }
     const options = normalizeOptions(context.options[0]);
+    const settings = calcInitialSettings(options, context.getCwd());
     isDebugMode = options.debugMode || false;
     isDebugMode && logContext(context);
-    const validator = new cspellLib.DocumentValidator(doc, options, defaultSettings);
+    const validator = new cspellLib.DocumentValidator(doc, options, settings);
     docValCache.set(doc, validator);
     return validator;
 }
+function calcInitialSettings(options, cwd) {
+    const { customWordListFile } = options;
+    if (!customWordListFile)
+        return defaultSettings;
+    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 }],
+        dictionaries: ['eslint-plugin-custom-words'],
+    };
+    return settings;
+}
 function getTextDocument(filename, content) {
     var _a;
     if (((_a = cache.lastDoc) === null || _a === void 0 ? void 0 : _a.filename) === filename) {
         return cache.lastDoc.doc;
     }
     const doc = cspellLib.createTextDocument({ uri: filename, content });
-    // console.error(`CreateTextDocument: ${doc.uri}`);
     cache.lastDoc = { filename, doc };
     return doc;
 }
+/**
+ * This wrapper is used to add a
+ */
+class WrapFix {
+    /**
+     *
+     * @param fix - the example Fix
+     * @param onGetText - called when `fix.text` is accessed
+     * @param limit - limit the number of times onGetText is called. Set it to `-1` for infinite.
+     */
+    constructor(fix, onGetText, limit = 1) {
+        this.fix = fix;
+        this.onGetText = onGetText;
+        this.limit = limit;
+    }
+    get range() {
+        return this.fix.range;
+    }
+    get text() {
+        if (this.limit) {
+            this.limit--;
+            this.onGetText();
+        }
+        return this.fix.text;
+    }
+}
+function isCustomWordListFile(value) {
+    return !!value && typeof value === 'object';
+}
 
 exports.configs = configs;
 exports.rules = rules;

package/dist/index.mjs

@@ -1,21 +1,59 @@
 /*!
- * @cspell/eslint-plugin v6.2.3
+ * @cspell/eslint-plugin v6.4.0-alpha.0
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
  */
 
 import assert from 'assert';
-import { DocumentValidator, createTextDocument } from 'cspell-lib';
+import { refreshDictionaryCache, DocumentValidator, createTextDocument } from 'cspell-lib';
+import * as path from 'path';
 import { format } from 'util';
+import * as fs from 'fs';
+
+const sortFn = new Intl.Collator().compare;
+function addWordToCustomWordList(customWordListPath, word) {
+    const content = readFile(customWordListPath) || '\n';
+    const lineEndingMatch = content.match(/\r?\n/);
+    const lineEnding = (lineEndingMatch === null || lineEndingMatch === void 0 ? void 0 : lineEndingMatch[0]) || '\n';
+    const words = new Set(content
+        .split(/\n/g)
+        .map((a) => a.trim())
+        .filter((a) => !!a));
+    words.add(word);
+    const lines = [...words];
+    lines.sort(sortFn);
+    writeFile(customWordListPath, lines.join(lineEnding) + lineEnding);
+}
+function readFile(file) {
+    try {
+        return fs.readFileSync(file, 'utf-8');
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+function writeFile(file, content) {
+    makeDir(path.dirname(file));
+    fs.writeFileSync(file, content);
+}
+function makeDir(dir) {
+    try {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    catch (e) {
+        console.log(e);
+    }
+}
 
 const defaultCheckOptions = {
     checkComments: true,
     checkIdentifiers: true,
     checkStrings: true,
     checkStringTemplates: true,
-    ignoreImports: true,
+    customWordListFile: undefined,
     ignoreImportProperties: true,
+    ignoreImports: true,
 };
 const defaultOptions = {
     ...defaultCheckOptions,
@@ -31,6 +69,28 @@ function normalizeOptions(opts) {
 var $schema = "http://json-schema.org/draft-07/schema#";
 var additionalProperties = false;
 var 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"
+	}
 };
 var properties = {
 	checkComments: {
@@ -53,6 +113,17 @@ var properties = {
 		description: "Spell check strings",
 		type: "boolean"
 	},
+	customWordListFile: {
+		anyOf: [
+			{
+				$ref: "#/definitions/CustomWordListFilePath"
+			},
+			{
+				$ref: "#/definitions/CustomWordListFile"
+			}
+		],
+		description: "Specify a path to a custom word list file"
+	},
 	debugMode: {
 		"default": false,
 		description: "Output debug logs",
@@ -98,6 +169,7 @@ const messages = {
     wordUnknown: 'Unknown word: "{{word}}"',
     wordForbidden: 'Forbidden word: "{{word}}"',
     suggestWord: '{{word}}',
+    addWordToDictionary: 'Add "{{word}}" to {{dictionary}}',
 };
 const meta = {
     docs: {
@@ -149,7 +221,6 @@ function create(context) {
         if (!options.checkStringTemplates)
             return;
         debugNode(node, node.value);
-        // console.log('Template: %o', node.value);
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
@@ -265,8 +336,31 @@ function create(context) {
                 fix: fixFactory(word),
             };
         }
+        function createAddWordToDictionaryFix(word) {
+            if (!isCustomWordListFile(options.customWordListFile) || !options.customWordListFile.addWords) {
+                return undefined;
+            }
+            const dictFile = path.resolve(context.getCwd(), options.customWordListFile.path);
+            const data = { word, dictionary: path.basename(dictFile) };
+            const messageId = 'addWordToDictionary';
+            return {
+                messageId,
+                data,
+                fix: (_fixer) => {
+                    // This wrapper is a hack to delay applying the fix until it is actually used.
+                    // But it is not reliable, since ESLint + extension will randomly read the value.
+                    return new WrapFix({ range: [start, end], text: word }, () => {
+                        refreshDictionaryCache(0);
+                        addWordToCustomWordList(dictFile, word);
+                        validator.updateDocumentText(context.getSourceCode().getText());
+                    });
+                },
+            };
+        }
         log('Suggestions: %o', issue.suggestions);
-        const suggest = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
+        const suggestions = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
+        const addWordFix = createAddWordToDictionaryFix(issue.text);
+        const suggest = suggestions || addWordFix ? (suggestions || []).concat(addWordFix ? [addWordFix] : []) : undefined;
         const des = {
             messageId,
             data,
@@ -428,26 +522,69 @@ function getDocValidator(context) {
     const doc = getTextDocument(context.getFilename(), text);
     const cachedValidator = docValCache.get(doc);
     if (cachedValidator) {
+        refreshDictionaryCache(0);
         cachedValidator.updateDocumentText(text);
         return cachedValidator;
     }
     const options = normalizeOptions(context.options[0]);
+    const settings = calcInitialSettings(options, context.getCwd());
     isDebugMode = options.debugMode || false;
     isDebugMode && logContext(context);
-    const validator = new DocumentValidator(doc, options, defaultSettings);
+    const validator = new DocumentValidator(doc, options, settings);
     docValCache.set(doc, validator);
     return validator;
 }
+function calcInitialSettings(options, cwd) {
+    const { customWordListFile } = options;
+    if (!customWordListFile)
+        return defaultSettings;
+    const filePath = isCustomWordListFile(customWordListFile) ? customWordListFile.path : customWordListFile;
+    const dictFile = path.resolve(cwd, filePath);
+    const settings = {
+        ...defaultSettings,
+        dictionaryDefinitions: [{ name: 'eslint-plugin-custom-words', path: dictFile }],
+        dictionaries: ['eslint-plugin-custom-words'],
+    };
+    return settings;
+}
 function getTextDocument(filename, content) {
     var _a;
     if (((_a = cache.lastDoc) === null || _a === void 0 ? void 0 : _a.filename) === filename) {
         return cache.lastDoc.doc;
     }
     const doc = createTextDocument({ uri: filename, content });
-    // console.error(`CreateTextDocument: ${doc.uri}`);
     cache.lastDoc = { filename, doc };
     return doc;
 }
+/**
+ * This wrapper is used to add a
+ */
+class WrapFix {
+    /**
+     *
+     * @param fix - the example Fix
+     * @param onGetText - called when `fix.text` is accessed
+     * @param limit - limit the number of times onGetText is called. Set it to `-1` for infinite.
+     */
+    constructor(fix, onGetText, limit = 1) {
+        this.fix = fix;
+        this.onGetText = onGetText;
+        this.limit = limit;
+    }
+    get range() {
+        return this.fix.range;
+    }
+    get text() {
+        if (this.limit) {
+            this.limit--;
+            this.onGetText();
+        }
+        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.2.4-alpha.0",
+  "version": "6.4.0",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -59,20 +59,20 @@
     "@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.3",
-    "@typescript-eslint/parser": "^5.30.6",
-    "@typescript-eslint/types": "^5.30.6",
-    "@typescript-eslint/typescript-estree": "^5.30.6",
-    "eslint": "^8.19.0",
+    "@types/estree": "^1.0.0",
+    "@types/node": "^18.0.6",
+    "@typescript-eslint/parser": "^5.30.7",
+    "@typescript-eslint/types": "^5.30.7",
+    "@typescript-eslint/typescript-estree": "^5.30.7",
+    "eslint": "^8.20.0",
     "mocha": "^10.0.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.76.0",
+    "rollup": "^2.77.0",
     "rollup-plugin-dts": "^4.2.2",
     "ts-json-schema-generator": "^1.0.0"
   },
   "dependencies": {
-    "cspell-lib": "^6.2.4-alpha.0"
+    "cspell-lib": "^6.4.0"
   },
-  "gitHead": "3509b9fb14722e573713ba1828af6da6088a24e8"
+  "gitHead": "e10256a7593f449cecc55600b12710264e106a24"
 }