fix: resolve imports from ESLint plugin (#5790)

Author: Jason3S

packages/cspell-eslint-plugin/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.

packages/cspell-eslint-plugin/assets/options.schema.json

@@ -326,6 +326,19 @@
       },
       "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": [
         {

packages/cspell-eslint-plugin/cspell.config.yaml

@@ -5,8 +5,4 @@ ignoreWords:
   - todos
   - bluelist
 words:
-  - estree
-  - pnpm
   - synckit
-  - treeshake
-  - tsbuildinfo

packages/cspell-eslint-plugin/fixtures/import-support/cspell.config.yaml

@@ -0,0 +1,3 @@
+import:
+  - '@internal/fixture-test-dictionary'
+words: []

packages/cspell-eslint-plugin/fixtures/import-support/cspell.test.json

@@ -0,0 +1,3 @@
+{
+    "noConfigSearch": true
+}

packages/cspell-eslint-plugin/fixtures/import-support/sample.ts

@@ -0,0 +1,18 @@
+/**
+ * This is a sample file to test the import support.
+ * Related to issue: [#5789](https://github.com/streetsidesoftware/cspell/issues/5789)
+ */
+
+export function sample() {
+    return 'sample';
+}
+
+export const words = [
+    `
+    readstring
+    resetmemorycategory
+    retargeting
+    rrotate
+    rshift
+    `,
+];

packages/cspell-eslint-plugin/package.json

@@ -80,6 +80,8 @@
     "@eslint/eslintrc": "^3.1.0",
     "@eslint/js": "^9.5.0",
     "@internal/cspell-eslint-plugin-scripts": "workspace:*",
+    "@internal/fixture-test-dictionary": "workspace:*",
+    "@types/eslint": "^8.56.10",
     "@types/estree": "^1.0.5",
     "@types/mocha": "^10.0.7",
     "@typescript-eslint/parser": "^7.13.1",
@@ -101,6 +103,7 @@
   },
   "dependencies": {
     "@cspell/cspell-types": "workspace:*",
+    "@cspell/url": "workspace:*",
     "cspell-lib": "workspace:*",
     "synckit": "^0.9.0"
   },

packages/cspell-eslint-plugin/src/common/options.cts

@@ -103,6 +103,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.
      *

packages/cspell-eslint-plugin/src/plugin/cspell-eslint-plugin.cts

@@ -131,7 +131,7 @@ function create(context: Rule.RuleContext): Rule.RuleListener {
                 '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));
     }

packages/cspell-eslint-plugin/src/plugin/defaultCheckOptions.cts

@@ -7,6 +7,7 @@ export const defaultCheckOptions: Required<Check> = {
     checkStrings: true,
     checkStringTemplates: true,
     configFile: '',
+    cspellOptionsRoot: '',
     cspell: {
         words: [],
         flagWords: [],
@@ -26,6 +27,7 @@ export const defaultOptions: RequiredOptions = {
 };
 
 export function normalizeOptions(opts: Options | undefined, cwd: string): WorkerOptions {
-    const options: WorkerOptions = Object.assign({}, defaultOptions, opts || {}, { cwd });
+    const cspellOptionsRoot = opts?.cspellOptionsRoot || 'eslint-configuration-file';
+    const options: WorkerOptions = Object.assign({}, defaultOptions, opts || {}, { cspellOptionsRoot, cwd });
     return options;
 }