@cspell/eslint-plugin 8.7.0 → 8.8.0

package/README.md

@@ -140,6 +140,12 @@ interface Options {
    * @default true
    */
   checkComments?: boolean;
+  /**
+   * Path to the cspell configuration file.
+   * Relative paths, will be relative to the current working directory.
+   * @since 8.8.0
+   */
+  configFile?: string;
   /**
    * Some CSpell Settings
    */
@@ -246,6 +252,22 @@ export default [
 }
 ```
 
+## `configFile` - Using a CSpell Configuration File
+
+**`eslint.config.mjs`**
+
+```js
+  rules: {
+      '@cspell/spellchecker': [
+          'error',
+          {
+              //
+              configFile: new URL('./cspell.config.yaml', import.meta.url).toString(),
+          },
+      ],
+  },
+```
+
 ## `autoFix`
 
 When enabled, `autoFix` corrects any spelling issues that have a single "preferred" suggestion. It attempts to match

package/assets/options.schema.json

@@ -33,6 +33,10 @@
       "description": "Spell check strings",
       "type": "boolean"
     },
+    "configFile": {
+      "description": "Path to the cspell configuration file. Relative paths, will be relative to the current working directory.",
+      "type": "string"
+    },
     "cspell": {
       "additionalProperties": false,
       "description": "CSpell options to pass to the spell checker.",
@@ -45,8 +49,19 @@
         "dictionaries": {
           "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
           "items": {
-            "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }",
-            "type": "string"
+            "anyOf": [
+              {
+                "description": "This a reference to a named dictionary. It is expected to match the name of a dictionary.",
+                "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
+                "type": "string"
+              },
+              {
+                "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.",
+                "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
+                "type": "string"
+              }
+            ],
+            "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
           },
           "type": "array"
         },
@@ -122,8 +137,49 @@
         "ignoreRegExpList": {
           "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
           "items": {
-            "description": "A PatternRef is a Pattern or PatternId.",
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "description": "This matches the name in a pattern definition.",
+                "type": "string"
+              },
+              {
+                "enum": [
+                  "Base64",
+                  "Base64MultiLine",
+                  "Base64SingleLine",
+                  "CStyleComment",
+                  "CStyleHexValue",
+                  "CSSHexValue",
+                  "CommitHash",
+                  "CommitHashLink",
+                  "Email",
+                  "EscapeCharacters",
+                  "HexValues",
+                  "href",
+                  "PhpHereDoc",
+                  "PublicKey",
+                  "RsaCert",
+                  "SshRsa",
+                  "SHA",
+                  "HashStrings",
+                  "SpellCheckerDisable",
+                  "SpellCheckerDisableBlock",
+                  "SpellCheckerDisableLine",
+                  "SpellCheckerDisableNext",
+                  "SpellCheckerIgnoreInDocSetting",
+                  "string",
+                  "UnicodeRef",
+                  "Urls",
+                  "UUID",
+                  "Everything"
+                ],
+                "type": "string"
+              }
+            ],
+            "description": "A PatternRef is a Pattern or PatternId."
           },
           "type": "array"
         },
@@ -153,8 +209,49 @@
         "includeRegExpList": {
           "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
           "items": {
-            "description": "A PatternRef is a Pattern or PatternId.",
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "description": "This matches the name in a pattern definition.",
+                "type": "string"
+              },
+              {
+                "enum": [
+                  "Base64",
+                  "Base64MultiLine",
+                  "Base64SingleLine",
+                  "CStyleComment",
+                  "CStyleHexValue",
+                  "CSSHexValue",
+                  "CommitHash",
+                  "CommitHashLink",
+                  "Email",
+                  "EscapeCharacters",
+                  "HexValues",
+                  "href",
+                  "PhpHereDoc",
+                  "PublicKey",
+                  "RsaCert",
+                  "SshRsa",
+                  "SHA",
+                  "HashStrings",
+                  "SpellCheckerDisable",
+                  "SpellCheckerDisableBlock",
+                  "SpellCheckerDisableLine",
+                  "SpellCheckerDisableNext",
+                  "SpellCheckerIgnoreInDocSetting",
+                  "string",
+                  "UnicodeRef",
+                  "Urls",
+                  "UUID",
+                  "Everything"
+                ],
+                "type": "string"
+              }
+            ],
+            "description": "A PatternRef is a Pattern or PatternId."
           },
           "type": "array"
         },

package/dist/common/logger.cjs

@@ -4,9 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultLogger = exports.Logger = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const util_1 = require("util");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_util_1 = require("node:util");
 const debugMode = false;
 class Logger {
     options;
@@ -17,9 +17,9 @@ class Logger {
     useAsync = false;
     constructor(options) {
         this.options = options;
-        this.cwd = path_1.default.resolve(options.cwd || '.');
+        this.cwd = node_path_1.default.resolve(options.cwd || '.');
         const logFileBasename = options.logFile || '.cspell-eslint-plugin.log';
-        this.logFile = path_1.default.resolve(this.cwd, logFileBasename);
+        this.logFile = node_path_1.default.resolve(this.cwd, logFileBasename);
         this.logToFile = options.logToFile ?? true;
         this.enabled = options.enabled ?? debugMode;
         this.useAsync = options.useAsync ?? false;
@@ -29,10 +29,10 @@ class Logger {
             return;
         if (!this.logToFile)
             return console.log(...p);
-        const message = new Date().toISOString() + ' ' + prefixLines((0, util_1.format)(...p), '  ') + '\n';
+        const message = new Date().toISOString() + ' ' + prefixLines((0, node_util_1.format)(...p), '  ') + '\n';
         this.useAsync
-            ? fs_1.default.appendFile(this.logFile, message, (err) => err && console.error(err))
-            : fs_1.default.appendFileSync(this.logFile, message);
+            ? node_fs_1.default.appendFile(this.logFile, message, (err) => err && console.error(err))
+            : node_fs_1.default.appendFileSync(this.logFile, message);
         return;
     }
     log = this._log.bind(this);

package/dist/common/options.d.cts

@@ -71,6 +71,12 @@ export interface Check {
      * @default true
      */
     checkComments?: boolean;
+    /**
+     * Path to the cspell configuration file.
+     * Relative paths, will be relative to the current working directory.
+     * @since 8.8.0
+     */
+    configFile?: string;
     /**
      * CSpell options to pass to the spell checker.
      */

package/dist/plugin/cspell-eslint-plugin.cjs

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.plugin = exports.configs = exports.meta = exports.rules = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
+// cspell:ignore TSESTree
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const synckit_1 = require("synckit");
 const logger_cjs_1 = require("../common/logger.cjs");
 const defaultCheckOptions_cjs_1 = require("./defaultCheckOptions.cjs");
-const optionsSchema = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../assets/options.schema.json'), 'utf8'));
+const optionsSchema = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, '../../assets/options.schema.json'), 'utf8'));
 const schema = optionsSchema;
-const spellCheck = (0, synckit_1.createSyncFn)(require.resolve('../worker/worker.mjs'), 30000);
+const spellCheck = (0, synckit_1.createSyncFn)(require.resolve('../worker/worker.mjs'), 30_000);
 const messages = {
     wordUnknown: 'Unknown word: "{{word}}"',
     wordForbidden: 'Forbidden word: "{{word}}"',
@@ -27,6 +28,7 @@ const ruleMeta = {
 };
 let isDebugMode = false;
 function nullFix() {
+    // eslint-disable-next-line unicorn/no-null
     return null;
 }
 function create(context) {

package/dist/plugin/cspell-eslint-plugin.d.cts

@@ -11,7 +11,7 @@ export declare const plugin: {
     rules: {
         spellchecker: Rule.RuleModule;
     };
-    configs: Record<string, ESLint.ConfigData<import("eslint").Linter.RulesRecord> | import("eslint").Linter.FlatConfig | import("eslint").Linter.FlatConfig[]>;
+    configs: Record<string, ESLint.ConfigData<import("eslint").Linter.RulesRecord> | import("eslint").Linter.FlatConfig<import("eslint").Linter.RulesRecord> | import("eslint").Linter.FlatConfig<import("eslint").Linter.RulesRecord>[]>;
     meta: {
         readonly name: "@cspell";
     };

package/dist/plugin/defaultCheckOptions.cjs

@@ -7,6 +7,7 @@ exports.defaultCheckOptions = {
     checkJSXText: true,
     checkStrings: true,
     checkStringTemplates: true,
+    configFile: '',
     cspell: {
         words: [],
         flagWords: [],

package/dist/plugin/index.cjs

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rules = exports.meta = exports.configs = void 0;
-const cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
-var cspell_eslint_plugin_cjs_2 = require("./cspell-eslint-plugin.cjs");
-Object.defineProperty(exports, "configs", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.configs; } });
-Object.defineProperty(exports, "meta", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.meta; } });
-Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.rules; } });
-exports.default = cspell_eslint_plugin_cjs_1.plugin;
+exports.rules = exports.meta = exports.default = exports.configs = void 0;
+var cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
+Object.defineProperty(exports, "configs", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.configs; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.plugin; } });
+Object.defineProperty(exports, "meta", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.meta; } });
+Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.rules; } });
 //# sourceMappingURL=index.cjs.map

package/dist/plugin/index.d.cts

@@ -1,5 +1,3 @@
 export type { Options } from '../common/options.cjs';
-import { plugin } from './cspell-eslint-plugin.cjs';
-export { configs, meta, rules } from './cspell-eslint-plugin.cjs';
-export default plugin;
+export { configs, plugin as default, meta, rules } from './cspell-eslint-plugin.cjs';
 //# sourceMappingURL=index.d.cts.map

package/dist/plugin/recommended.d.cts

@@ -1,4 +1,4 @@
 import type { Linter } from 'eslint';
 export declare const plugins: Record<string, import("eslint").ESLint.Plugin> | undefined;
-export declare const rules: Linter.RulesRecord | undefined;
+export declare const rules: Partial<Linter.RulesRecord> | undefined;
 //# sourceMappingURL=recommended.d.cts.map

package/dist/worker/spellCheck.mjs

@@ -1,7 +1,8 @@
-import assert from 'assert';
+// cspell:ignore TSESTree
+import assert from 'node:assert';
+import * as path from 'node:path';
+import { format } from 'node:util';
 import { createTextDocument, DocumentValidator, extractImportErrors, getDictionary, refreshDictionaryCache, } from 'cspell-lib';
-import * as path from 'path';
-import { format } from 'util';
 import { getDefaultLogger } from '../common/logger.cjs';
 import { walkTree } from './walkTree.mjs';
 const defaultSettings = {
@@ -311,6 +312,16 @@ function calcInitialSettings(options) {
         ignoreWords: cspell?.ignoreWords || [],
         flagWords: cspell?.flagWords || [],
     };
+    if (options.configFile) {
+        const optionCspellImport = options.cspell?.import;
+        const importConfig = typeof optionCspellImport === 'string'
+            ? [optionCspellImport]
+            : Array.isArray(optionCspellImport)
+                ? optionCspellImport
+                : [];
+        importConfig.push(options.configFile);
+        settings.import = importConfig;
+    }
     if (customWordListFile) {
         const filePath = isCustomWordListFile(customWordListFile) ? customWordListFile.path : customWordListFile;
         const { dictionaries = [], dictionaryDefinitions = [] } = settings;
@@ -360,9 +371,9 @@ function normalizeSuggestions(suggestions, nodeType) {
         if (!isSpecial.test(sug.word))
             return sug;
         const s = { ...sug };
-        s.word = s.word.replace(allSpecial, '_');
+        s.word = s.word.replaceAll(allSpecial, '_');
         if (s.wordAdjustedToMatchCase) {
-            s.wordAdjustedToMatchCase = s.wordAdjustedToMatchCase.replace(allSpecial, '_');
+            s.wordAdjustedToMatchCase = s.wordAdjustedToMatchCase.replaceAll(allSpecial, '_');
         }
         return s;
     });
@@ -376,7 +387,7 @@ function deepEqual(a, b) {
         assert.deepStrictEqual(a, b);
         return true;
     }
-    catch (e) {
+    catch {
         return false;
     }
 }

package/dist/worker/worker.mjs

@@ -1,5 +1,4 @@
 // @ts-check
-/* eslint-disable n/no-missing-import */
 /**
  * @typedef {import('estree').Node} Node
  * @typedef {import('./types.cjs').Issue} Issue
@@ -21,7 +20,6 @@ runAsWorker(
  */
 async (filename, text, root, options) => {
     if (!spellChecker) {
-        // eslint-disable-next-line import/no-unresolved
         spellChecker = await import('./spellCheck.mjs');
     }
     return spellChecker.spellCheck(filename, text, root, options);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "8.7.0",
+  "version": "8.8.0",
   "description": "CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -75,29 +75,29 @@
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.0.2",
-    "@eslint/js": "^9.0.0",
+    "@eslint/js": "^9.1.1",
     "@types/estree": "^1.0.5",
     "@types/mocha": "^10.0.6",
-    "@typescript-eslint/parser": "^7.6.0",
-    "@typescript-eslint/types": "^7.6.0",
-    "eslint": "^9.0.0",
-    "eslint-plugin-n": "^17.1.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "@typescript-eslint/types": "^7.8.0",
+    "eslint": "^9.1.1",
+    "eslint-plugin-n": "^17.4.0",
     "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-simple-import-sort": "^12.0.0",
-    "globals": "^15.0.0",
+    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "globals": "^15.1.0",
     "mocha": "^10.4.0",
-    "ts-json-schema-generator": "^1.5.1",
-    "typescript": "^5.4.4",
-    "typescript-eslint": "^7.6.0"
+    "ts-json-schema-generator": "^2.1.1",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.8.0"
   },
   "dependencies": {
-    "@cspell/cspell-types": "8.7.0",
-    "cspell-lib": "8.7.0",
+    "@cspell/cspell-types": "8.8.0",
+    "cspell-lib": "8.8.0",
     "estree-walker": "^3.0.3",
     "synckit": "^0.9.0"
   },
   "peerDependencies": {
     "eslint": "^7 || ^8 || ^9"
   },
-  "gitHead": "5318079ed11fe77e981287ecf1c40d6f28dd91ed"
+  "gitHead": "a42bce675c00cb2d51809b3ae3894119ea4f5ce7"
 }