feat: Enable eslint plugin to call Async methods. (#4080)

Author: Jason3S

packages/cspell-eslint-plugin/cspell.json

@@ -5,6 +5,7 @@
     "words": [
         "estree",
         "pnpm",
+        "synckit",
         "treeshake",
         "tsbuildinfo"
     ]

packages/cspell-eslint-plugin/package.json

@@ -33,10 +33,10 @@
     "!**/*.map"
   ],
   "scripts": {
-    "build": "pnpm run build-schema && pnpm run build-rollup",
-    "build-rollup": "rollup --config rollup.config.ts --configPlugin typescript",
-    "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": "pnpm run build-rollup --watch",
+    "build": "pnpm build:schema && pnpm build:src",
+    "build:src": "tsc -p .",
+    "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": "tsc -p . --watch",
     "clean": "shx rm -rf dist coverage .tsbuildinfo",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "echo coverage",
@@ -54,10 +54,6 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.0.1",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-typescript": "^11.0.0",
     "@types/eslint": "^8.4.10",
     "@types/estree": "^1.0.0",
     "@types/node": "^18.11.18",
@@ -67,12 +63,11 @@
     "eslint": "^8.33.0",
     "eslint-plugin-react": "^7.32.2",
     "mocha": "^10.2.0",
-    "rollup": "^3.12.0",
-    "rollup-plugin-dts": "^5.1.1",
     "ts-json-schema-generator": "^1.2.0"
   },
   "dependencies": {
     "cspell-lib": "workspace:*",
-    "estree-walker": "^2.0.2"
+    "estree-walker": "^2.0.2",
+    "synckit": "^0.8.5"
   }
 }

packages/cspell-eslint-plugin/rollup.config.ts

@@ -0,0 +1,7 @@
+import type { Comment, Literal, Node } from 'estree';
+
+export interface JSXText extends Omit<Literal, 'type'> {
+    type: 'JSXText';
+}
+
+export type ASTNode = (Node | Comment | JSXText) & { parent?: Node };

packages/cspell-eslint-plugin/src/ASTNode.ts

@@ -37,10 +37,6 @@
         {
           "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"

packages/cspell-eslint-plugin/src/_auto_generated_/options.schema.json

@@ -1,16 +1,16 @@
 // cspell:ignore TSESTree
-import { refreshDictionaryCache } from 'cspell-lib';
 import type { Rule } from 'eslint';
-import * as path from 'path';
+import { createSyncFn } from 'synckit';
 
 import optionsSchema from './_auto_generated_/options.schema.json';
-import { addWordToCustomWordList } from './customWordList';
-import type { CustomWordListFile } from './options';
 import { normalizeOptions } from './options';
-import { type Issue, spellCheck, walkTree } from './worker';
+import type { Issue, SpellCheckSyncFn } from './spellCheck';
+import { walkTree } from './walkTree';
 
 const schema = optionsSchema as unknown as Rule.RuleMetaData['schema'];
 
+const spellCheck: SpellCheckSyncFn = createSyncFn(require.resolve('./worker'), undefined, 30000);
+
 interface PluginRules {
     ['spellchecker']: Rule.RuleModule;
 }
@@ -86,36 +86,9 @@ function create(context: Rule.RuleContext): Rule.RuleListener {
             };
         }
 
-        function createAddWordToDictionaryFix(word: string): Rule.SuggestionReportDescriptor | undefined {
-            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: MessageIds = '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);
-                    });
-                },
-            };
-        }
-
         log('Suggestions: %o', issue.suggestions);
         const suggestions: Rule.ReportDescriptorOptions['suggest'] = issue.suggestions?.map(createSug);
-        const addWordFix = createAddWordToDictionaryFix(issue.word);
-
-        const suggest =
-            suggestions || addWordFix ? (suggestions || []).concat(addWordFix ? [addWordFix] : []) : undefined;
+        const suggest = suggestions;
 
         const des: Rule.ReportDescriptor = {
             messageId,
@@ -169,32 +142,3 @@ export const configs = {
         },
     },
 };
-
-/**
- * This wrapper is used to add a
- */
-class WrapFix implements Rule.Fix {
-    /**
-     *
-     * @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(private fix: Rule.Fix, private onGetText: () => void, private limit = 1) {}
-
-    get range() {
-        return this.fix.range;
-    }
-
-    get text() {
-        if (this.limit) {
-            this.limit--;
-            this.onGetText();
-        }
-        return this.fix.text;
-    }
-}
-
-function isCustomWordListFile(value: string | CustomWordListFile | undefined): value is CustomWordListFile {
-    return !!value && typeof value === 'object';
-}

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

@@ -86,12 +86,6 @@ export interface CustomWordListFile {
      * 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 const defaultCheckOptions: Required<Check> = {

packages/cspell-eslint-plugin/src/options.ts

@@ -4,15 +4,12 @@ import assert from 'assert';
 import type { CSpellSettings, TextDocument, ValidationIssue } from 'cspell-lib';
 import { createTextDocument, DocumentValidator, refreshDictionaryCache } from 'cspell-lib';
 import type { Comment, Identifier, ImportSpecifier, Literal, Node, TemplateElement } from 'estree';
-import { walk } from 'estree-walker';
 import * as path from 'path';
 import { format } from 'util';
 
+import type { ASTNode, JSXText } from './ASTNode';
 import type { CustomWordListFile, WorkerOptions } from './options';
-
-interface JSXText extends Omit<Literal, 'type'> {
-    type: 'JSXText';
-}
+import { walkTree } from './walkTree';
 
 export interface Issue {
     start: number;
@@ -22,8 +19,6 @@ export interface Issue {
     suggestions: string[] | undefined;
 }
 
-type ASTNode = (Node | Comment | JSXText) & { parent?: Node };
-
 const defaultSettings: CSpellSettings = {
     patterns: [
         // @todo: be able to use cooked / transformed strings.
@@ -41,12 +36,16 @@ function log(...args: Parameters<typeof console.log>) {
     console.log(...args);
 }
 
-export function spellCheck(filename: string, text: string, root: Node, options: WorkerOptions): Issue[] {
+type SpellCheckFn = typeof spellCheck;
+
+export type SpellCheckSyncFn = (...p: Parameters<SpellCheckFn>) => Awaited<ReturnType<SpellCheckFn>>;
+
+export async function spellCheck(filename: string, text: string, root: Node, options: WorkerOptions): Promise<Issue[]> {
     const toIgnore = new Set<string>();
     const importedIdentifiers = new Set<string>();
     isDebugMode = options.debugMode || false;
     const validator = getDocValidator(filename, text, options);
-    validator.prepareSync();
+    await validator.prepare();
     const issues: Issue[] = [];
 
     function checkLiteral(node: Literal | ASTNode) {
@@ -373,18 +372,3 @@ function getTextDocument(filename: string, content: string): TextDocument {
 function isCustomWordListFile(value: string | CustomWordListFile | undefined): value is CustomWordListFile {
     return !!value && typeof value === 'object';
 }
-
-export function walkTree(node: ASTNode, enter: (node: ASTNode, parent: ASTNode | undefined, key: string) => void) {
-    const visited = new Set<object>();
-
-    walk(node, {
-        enter: function (node, parent, key) {
-            if (visited.has(node) || key === 'tokens') {
-                this.skip();
-                return;
-            }
-            visited.add(node);
-            enter(node as ASTNode, parent as ASTNode, key);
-        },
-    });
-}

packages/cspell-eslint-plugin/src/worker.ts packages/cspell-eslint-plugin/src/spellCheck.ts

@@ -0,0 +1,18 @@
+import { walk } from 'estree-walker';
+
+import type { ASTNode } from './ASTNode';
+
+export function walkTree(node: ASTNode, enter: (node: ASTNode, parent: ASTNode | undefined, key: string) => void) {
+    const visited = new Set<object>();
+
+    walk(node, {
+        enter: function (node, parent, key) {
+            if (visited.has(node) || key === 'tokens') {
+                this.skip();
+                return;
+            }
+            visited.add(node);
+            enter(node as ASTNode, parent as ASTNode, key);
+        },
+    });
+}