@cspell/eslint-plugin 8.9.0 → 8.10.0

package/README.md

@@ -193,6 +193,22 @@ interface Options {
     dictionaryDefinitions?: DictionaryDefinition[];
   };
 
+  /**
+   * Specify the root path of the cspell configuration.
+   * It is used to resolve `imports` found in {@link cspell}.
+   *
+   * example:
+   * ```js
+   * cspellOptionsRoot: import.meta.url
+   * // or
+   * cspellOptionsRoot: __filename
+   * ```
+   *
+   * @default cwd
+   *
+   */
+  cspellOptionsRoot?: string | URL;
+
   /**
    * Specify a path to a custom word list file.
    *
@@ -282,22 +298,6 @@ 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
@@ -324,6 +324,48 @@ When spell checking, if `colour` is not in one of the dictionaries, then `color`
 
 CSpell will match case, but not word stems. `blacklist` and `Blacklist` will get replaced, but not `blacklists`.
 
+## `configFile` - Using a CSpell Configuration File
+
+**`eslint.config.mjs`**
+
+```js
+rules: {
+    '@cspell/spellchecker': [
+        'error',
+        {
+            configFile: new URL('./cspell.config.yaml', import.meta.url).toString(),
+        },
+    ],
+},
+```
+
+## `cspell` and `cspellOptionsRoot` - CSpell Configuration
+
+It is possible to send `cspell` configuration to the spell checker. Where possible, use a cspell configuration file and set `configFile`. But there are cases where this is not possible or desired (like fewer configuration files).
+
+- Option `cspell` is used to pass along configuration to the spell checker.
+- Option `cspellOptionsRoot` is used to tell the spell checker how to find `cspell.import`s.
+
+Example: **`eslint.config.mjs`**
+
+```js
+rules: {
+    '@cspell/spellchecker': [
+        'warn',
+        {
+            cspell: {
+              import: ['./cspell.config.yaml', '@cspell/dict-de-de']
+            },
+            cspellOptionsRoot: import.meta.url,
+        },
+    ],
+},
+```
+
+Assuming `import.meta.url` is `file:///Users/ci/project/app/eslint.config.mjs`, this tells the spell checker to import `cspell.config.yaml` from `file:///Users/ci/project/app/cspell.config.yaml` and to search for package `@cspell/dict-de-de` starting at `file:///Users/ci/project/app/`.
+
+If `cspellOptionsRoot` is not specified, the current working directory is used.
+
 ## Checking Custom AST Nodes
 
 The `checkScope` setting is used to enable / disable checking AST Nodes. ESLint uses parsers to generate the AST (Abstract Syntax Tree) to evaluate a document. Each PlugIn gets access to the AST. `checkScope` can be used to handle new AST nodes when a custom parser is added. Some knowledge of the AST output by the parser is necessary.

package/assets/options.schema.json

@@ -6,21 +6,25 @@
     "autoFix": {
       "default": false,
       "description": "Automatically fix common mistakes. This is only possible if a single preferred suggestion is available.",
+      "markdownDescription": "Automatically fix common mistakes.\nThis is only possible if a single preferred suggestion is available.",
       "type": "boolean"
     },
     "checkComments": {
       "default": true,
       "description": "Spell check comments",
+      "markdownDescription": "Spell check comments",
       "type": "boolean"
     },
     "checkIdentifiers": {
       "default": true,
       "description": "Spell check identifiers (variables names, function names, class names, etc.)",
+      "markdownDescription": "Spell check identifiers (variables names, function names, class names, etc.)",
       "type": "boolean"
     },
     "checkJSXText": {
       "default": true,
       "description": "Spell check JSX Text",
+      "markdownDescription": "Spell check JSX Text",
       "type": "boolean"
     },
     "checkScope": {
@@ -30,39 +34,47 @@
         "items": [
           {
             "description": "The scope selector is a string that defines the context in which a rule applies. Examples:\n- `YAMLPair[value] YAMLScalar` - check the value of a YAML pair.\n- `YAMLPair[key] YAMLScalar` - check the key of a YAML pair.",
+            "markdownDescription": "The scope selector is a string that defines the context in which a rule applies.\nExamples:\n- `YAMLPair[value] YAMLScalar` - check the value of a YAML pair.\n- `YAMLPair[key] YAMLScalar` - check the key of a YAML pair.",
             "type": "string"
           },
           {
             "type": "boolean"
           }
         ],
+        "markdownDescription": "A scope selector entry is a tuple that defines a scope selector and whether to spell check it.",
         "maxItems": 2,
         "minItems": 2,
         "type": "array"
       },
+      "markdownDescription": "Scope selectors to spell check.\nThis is a list of scope selectors to spell check.\n\nExample:\n```js\ncheckScope: [\n    ['YAMLPair[key] YAMLScalar', true],\n    ['YAMLPair[value] YAMLScalar', true],\n    ['YAMLSequence[entries] YAMLScalar', true],\n    ['JSONProperty[key] JSONLiteral', true],\n    ['JSONProperty[value] JSONLiteral', true],\n    ['JSONArrayExpression JSONLiteral', true],\n],\n```",
       "type": "array"
     },
     "checkStringTemplates": {
       "default": true,
       "description": "Spell check template strings",
+      "markdownDescription": "Spell check template strings",
       "type": "boolean"
     },
     "checkStrings": {
       "default": true,
       "description": "Spell check strings",
+      "markdownDescription": "Spell check strings",
       "type": "boolean"
     },
     "configFile": {
       "description": "Path to the cspell configuration file. Relative paths, will be relative to the current working directory.",
+      "markdownDescription": "Path to the cspell configuration file.\nRelative paths, will be relative to the current working directory.",
       "type": "string"
     },
     "cspell": {
       "additionalProperties": false,
       "description": "CSpell options to pass to the spell checker.",
+      "markdownDescription": "CSpell options to pass to the spell checker.",
       "properties": {
         "allowCompoundWords": {
           "default": false,
-          "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
+          "description": "True to enable compound word checking.",
+          "markdownDescription": "True to enable compound word checking.",
           "type": "boolean"
         },
         "dictionaries": {
@@ -71,17 +83,21 @@
             "anyOf": [
               {
                 "description": "This a reference to a named dictionary. It is expected to match the name of a dictionary.",
+                "markdownDescription": "This a reference to a named dictionary.\nIt 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>`.",
+                "markdownDescription": "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>`.\n   Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\n   Overrides `!!<dictionary_name>`.",
                 "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
                 "type": "string"
               }
             ],
-            "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
+            "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }",
+            "markdownDescription": "Reference to a dictionary by name.\nOne of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
           },
+          "markdownDescription": "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/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
           "type": "array"
         },
         "dictionaryDefinitions": {
@@ -89,20 +105,24 @@
             "additionalProperties": false,
             "properties": {
               "description": {
-                "description": "Optional description.",
+                "description": "Optional description of the contents / purpose of the dictionary.",
+                "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
                 "type": "string"
               },
               "name": {
                 "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
+                "markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
                 "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
                 "type": "string"
               },
               "noSuggest": {
                 "description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+                "markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
                 "type": "boolean"
               },
               "path": {
                 "description": "Path to the file.",
+                "markdownDescription": "Path to the file.",
                 "type": "string"
               },
               "repMap": {
@@ -115,21 +135,24 @@
                   "minItems": 2,
                   "type": "array"
                 },
+                "markdownDescription": "Replacement pairs.",
                 "type": "array"
               },
               "type": {
                 "default": "S",
-                "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
+                "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
                 "enum": [
                   "S",
                   "W",
                   "C",
                   "T"
                 ],
+                "markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.\n\nNote: this settings does not apply to inline dictionaries or `.trie` files.",
                 "type": "string"
               },
               "useCompounds": {
                 "description": "Use Compounds.",
+                "markdownDescription": "Use Compounds.",
                 "type": "boolean"
               }
             },
@@ -144,6 +167,7 @@
         "enabled": {
           "default": true,
           "description": "Is the spell checker enabled.",
+          "markdownDescription": "Is the spell checker enabled.",
           "type": "boolean"
         },
         "flagWords": {
@@ -151,6 +175,7 @@
           "items": {
             "type": "string"
           },
+          "markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n  \"color: colour\",\n  \"incase: in case, encase\",\n  \"canot->cannot\",\n  \"cancelled->canceled\"\n]\n```",
           "type": "array"
         },
         "ignoreRegExpList": {
@@ -162,6 +187,7 @@
               },
               {
                 "description": "This matches the name in a pattern definition.",
+                "markdownDescription": "This matches the name in a pattern definition.",
                 "type": "string"
               },
               {
@@ -198,8 +224,10 @@
                 "type": "string"
               }
             ],
-            "description": "A PatternRef is a Pattern or PatternId."
+            "description": "A PatternRef is a Pattern or PatternId.",
+            "markdownDescription": "A PatternRef is a Pattern or PatternId."
           },
+          "markdownDescription": "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\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n  - >-\n   /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[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\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
           "type": "array"
         },
         "ignoreWords": {
@@ -207,23 +235,27 @@
           "items": {
             "type": "string"
           },
+          "markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
           "type": "array"
         },
         "import": {
           "anyOf": [
             {
               "description": "A File System Path. Relative paths are relative to the configuration file.",
+              "markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
               "type": "string"
             },
             {
               "items": {
                 "description": "A File System Path. Relative paths are relative to the configuration file.",
+                "markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
                 "type": "string"
               },
               "type": "array"
             }
           ],
-          "description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
+          "description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.",
+          "markdownDescription": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
         },
         "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).",
@@ -234,6 +266,7 @@
               },
               {
                 "description": "This matches the name in a pattern definition.",
+                "markdownDescription": "This matches the name in a pattern definition.",
                 "type": "string"
               },
               {
@@ -270,13 +303,16 @@
                 "type": "string"
               }
             ],
-            "description": "A PatternRef is a Pattern or PatternId."
+            "description": "A PatternRef is a Pattern or PatternId.",
+            "markdownDescription": "A PatternRef is a Pattern or PatternId."
           },
+          "markdownDescription": "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\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
           "type": "array"
         },
         "language": {
           "default": "en",
           "description": "Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch.",
+          "markdownDescription": "Current active spelling language. This specifies the language locale to use in choosing the\ngeneral dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch.",
           "type": "string"
         },
         "words": {
@@ -284,15 +320,30 @@
           "items": {
             "type": "string"
           },
+          "markdownDescription": "List of words to be considered correct.",
           "type": "array"
         }
       },
       "type": "object"
     },
+    "cspellOptionsRoot": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "format": "uri",
+          "type": "string"
+        }
+      ],
+      "description": "Specify the root path of the cspell configuration. It is used to resolve `imports` found in  {@link  cspell } .\n\nexample: ```js cspellOptionsRoot: import.meta.url // or cspellOptionsRoot: __filename ```",
+      "markdownDescription": "Specify the root path of the cspell configuration.\nIt is used to resolve `imports` found in  {@link  cspell } .\n\nexample:\n```js\ncspellOptionsRoot: import.meta.url\n// or\ncspellOptionsRoot: __filename\n```"
+    },
     "customWordListFile": {
       "anyOf": [
         {
           "description": "Specify a path to a custom word list file",
+          "markdownDescription": "Specify a path to a custom word list file",
           "type": "string"
         },
         {
@@ -300,6 +351,7 @@
           "properties": {
             "path": {
               "description": "Path to word list file. File format: 1 word per line",
+              "markdownDescription": "Path to word list file.\nFile format: 1 word per line",
               "type": "string"
             }
           },
@@ -309,30 +361,36 @@
           "type": "object"
         }
       ],
-      "description": "Specify a path to a custom word list file.\n\nexample: ```js customWordListFile: \"./myWords.txt\" ```"
+      "description": "Specify a path to a custom word list file.\n\nexample: ```js customWordListFile: \"./myWords.txt\" ```",
+      "markdownDescription": "Specify a path to a custom word list file.\n\nexample:\n```js\ncustomWordListFile: \"./myWords.txt\"\n```"
     },
     "debugMode": {
       "description": "Output debug logs to `.cspell-eslint-plugin.log` default false",
+      "markdownDescription": "Output debug logs to `.cspell-eslint-plugin.log`\ndefault false",
       "type": "boolean"
     },
     "generateSuggestions": {
       "default": true,
       "description": "Generate suggestions",
+      "markdownDescription": "Generate suggestions",
       "type": "boolean"
     },
     "ignoreImportProperties": {
       "default": true,
       "description": "Ignore the properties of imported variables, structures, and types.\n\nExample: ``` import { example } from 'third-party';\n\nconst msg = example.property; // `property` is not spell checked. ```",
+      "markdownDescription": "Ignore the properties of imported variables, structures, and types.\n\nExample:\n```\nimport { example } from 'third-party';\n\nconst msg = example.property; // `property` is not spell checked.\n```",
       "type": "boolean"
     },
     "ignoreImports": {
       "default": true,
       "description": "Ignore import and require names",
+      "markdownDescription": "Ignore import and require names",
       "type": "boolean"
     },
     "numSuggestions": {
       "default": 8,
       "description": "Number of spelling suggestions to make.",
+      "markdownDescription": "Number of spelling suggestions to make.",
       "type": "number"
     }
   },

package/dist/common/logger.cjs

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultLogger = exports.Logger = void 0;
+exports.Logger = void 0;
+exports.getDefaultLogger = getDefaultLogger;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const node_util_1 = require("node:util");
@@ -45,7 +46,6 @@ function getDefaultLogger() {
     logger = new Logger({});
     return logger;
 }
-exports.getDefaultLogger = getDefaultLogger;
 function prefixLines(text, prefix, startIndex = 1) {
     return text
         .split('\n')

package/dist/common/options.d.cts

@@ -81,6 +81,18 @@ export interface Check {
      * CSpell options to pass to the spell checker.
      */
     cspell?: CSpellOptions;
+    /**
+     * Specify the root path of the cspell configuration.
+     * It is used to resolve `imports` found in {@link cspell}.
+     *
+     * example:
+     * ```js
+     * cspellOptionsRoot: import.meta.url
+     * // or
+     * cspellOptionsRoot: __filename
+     * ```
+     */
+    cspellOptionsRoot?: string | URL;
     /**
      * Specify a path to a custom word list file.
      *

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

@@ -91,7 +91,7 @@ function create(context) {
         const { issues, errors } = spellCheck(filename, sc.text, sc.ast, options);
         if (errors && errors.length) {
             log('errors: %o', errors.map((e) => e.message));
-            errors.forEach((error) => console.error('%s', error.message));
+            errors.forEach((error) => context.report({ message: error.message, loc: { line: 1, column: 1 } }));
         }
         issues.forEach((issue) => reportIssue(issue));
     }

package/dist/plugin/defaultCheckOptions.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeOptions = exports.defaultOptions = exports.defaultCheckOptions = void 0;
+exports.defaultOptions = exports.defaultCheckOptions = void 0;
+exports.normalizeOptions = normalizeOptions;
 exports.defaultCheckOptions = {
     checkComments: true,
     checkIdentifiers: true,
@@ -8,6 +9,7 @@ exports.defaultCheckOptions = {
     checkStrings: true,
     checkStringTemplates: true,
     configFile: '',
+    cspellOptionsRoot: '',
     cspell: {
         words: [],
         flagWords: [],
@@ -25,8 +27,8 @@ exports.defaultOptions = {
     autoFix: false,
 };
 function normalizeOptions(opts, cwd) {
-    const options = Object.assign({}, exports.defaultOptions, opts || {}, { cwd });
+    const cspellOptionsRoot = opts?.cspellOptionsRoot || 'eslint-configuration-file';
+    const options = Object.assign({}, exports.defaultOptions, opts || {}, { cspellOptionsRoot, cwd });
     return options;
 }
-exports.normalizeOptions = normalizeOptions;
 //# sourceMappingURL=defaultCheckOptions.cjs.map

package/dist/worker/spellCheck.mjs

@@ -1,12 +1,14 @@
 // cspell:ignore TSESTree
 import assert from 'node:assert';
 import * as path from 'node:path';
+import { toFileDirURL, toFileURL } from '@cspell/url';
 import { createTextDocument, DocumentValidator, extractImportErrors, getDictionary, refreshDictionaryCache, } from 'cspell-lib';
 import { getDefaultLogger } from '../common/logger.cjs';
 import { defaultCheckedScopes } from './customScopes.mjs';
 import { AstPathScope, AstScopeMatcher, astScopeToString, mapNodeToScope, scopeItem } from './scope.mjs';
 import { walkTree } from './walkTree.mjs';
 const defaultSettings = {
+    name: 'eslint-configuration-file',
     patterns: [
     // @todo: be able to use cooked / transformed strings.
     // {
@@ -316,7 +318,8 @@ function getDocValidator(filename, text, options) {
         cachedValidator.updateDocumentText(text).catch(() => undefined);
         return cachedValidator;
     }
-    const validator = new DocumentValidator(doc, options, settings);
+    const resolveImportsRelativeTo = toFileURL(options.cspellOptionsRoot || import.meta.url, toFileDirURL(options.cwd));
+    const validator = new DocumentValidator(doc, { ...options, resolveImportsRelativeTo }, settings);
     docValCache.set(doc, validator);
     return validator;
 }

package/dist/worker/worker.d.mts

@@ -1,5 +1,5 @@
-export type Node = import('estree').Node;
-export type Issue = import('./types.cjs').Issue;
-export type SpellCheckResults = import('./types.cjs').SpellCheckResults;
-export type WorkerOptions = import('../common/options.cjs').WorkerOptions;
+export type Node = import("estree").Node;
+export type Issue = import("./types.cjs").Issue;
+export type SpellCheckResults = import("./types.cjs").SpellCheckResults;
+export type WorkerOptions = import("../common/options.cjs").WorkerOptions;
 //# sourceMappingURL=worker.d.mts.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "8.9.0",
+  "version": "8.10.0",
   "description": "CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -55,7 +55,8 @@
     "bt": "pnpm build && pnpm test",
     "build": "pnpm build:schema && pnpm build:src",
     "build:src": "tsc -b ./tsconfig.json -f",
-    "build:schema": "ts-json-schema-generator --no-top-ref --expose none --path src/common/options.cts --type Options  -o  ./assets/options.schema.json",
+    "build:schema": "pnpm build-options-schema",
+    "build:schema:old": "ts-json-schema-generator --no-top-ref --expose none --path src/common/options.cts --type Options  -o  ./assets/options.schema.json",
     "watch": "tsc -b ./tsconfig.json --watch -f",
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "clean-build": "pnpm run clean && pnpm run build",
@@ -77,33 +78,37 @@
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.5.0",
+    "@eslint/js": "^9.6.0",
+    "@internal/cspell-eslint-plugin-scripts": "",
+    "@internal/fixture-test-dictionary": "",
+    "@types/eslint": "^8.56.10",
     "@types/estree": "^1.0.5",
-    "@types/mocha": "^10.0.6",
-    "@typescript-eslint/parser": "^7.13.1",
-    "@typescript-eslint/types": "^7.13.1",
-    "eslint": "^9.5.0",
+    "@types/mocha": "^10.0.7",
+    "@typescript-eslint/parser": "^7.15.0",
+    "@typescript-eslint/types": "^7.15.0",
+    "eslint": "^9.6.0",
     "eslint-plugin-jsonc": "^2.16.0",
     "eslint-plugin-mdx": "^3.1.5",
     "eslint-plugin-n": "^17.9.0",
-    "eslint-plugin-react": "^7.34.2",
+    "eslint-plugin-react": "^7.34.3",
     "eslint-plugin-simple-import-sort": "^12.1.0",
     "eslint-plugin-yml": "^1.14.0",
-    "globals": "^15.6.0",
+    "globals": "^15.8.0",
     "jsonc-eslint-parser": "^2.4.0",
-    "mocha": "^10.4.0",
+    "mocha": "^10.5.2",
     "ts-json-schema-generator": "^2.3.0",
-    "typescript": "^5.4.5",
-    "typescript-eslint": "^7.13.1",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.15.0",
     "yaml-eslint-parser": "^1.2.3"
   },
   "dependencies": {
-    "@cspell/cspell-types": "8.9.0",
-    "cspell-lib": "8.9.0",
+    "@cspell/cspell-types": "8.10.0",
+    "@cspell/url": "8.10.0",
+    "cspell-lib": "8.10.0",
     "synckit": "^0.9.0"
   },
   "peerDependencies": {
     "eslint": "^7 || ^8 || ^9"
   },
-  "gitHead": "33c513cf848a61fb1ebcea1b9c67505a31447411"
+  "gitHead": "a5dde6ae7e2ac86ac956220d4b8c39a0e58e1bc6"
 }