@cspell/eslint-plugin 6.26.0 → 6.26.2

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

@@ -64,13 +64,13 @@ function create(context) {
             };
         }
         log('Suggestions: %o', issue.suggestions);
-        const fixable = issue.suggestionsEx?.filter((sug) => !!sug.isPreferred);
+        const fixable = issue.suggestions?.filter((sug) => !!sug.isPreferred);
         const canFix = fixable?.length === 1;
         const preferredSuggestion = autoFix && canFix && fixable[0];
         const fix = preferredSuggestion
             ? fixFactory(preferredSuggestion.wordAdjustedToMatchCase || preferredSuggestion.word)
             : nullFix;
-        const suggestions = issue.suggestionsEx?.map((sug) => createSug(sug));
+        const suggestions = issue.suggestions?.map((sug) => createSug(sug));
         const suggest = suggestions;
         const des = {
             messageId,

package/dist/worker/ASTNode.d.mts

@@ -5,3 +5,4 @@ export interface JSXText extends Omit<Literal, 'type'> {
 export type ASTNode = (Node | Comment | JSXText) & {
     parent?: Node;
 };
+export type NodeType = ASTNode['type'];

package/dist/worker/spellCheck.d.mts

@@ -1,13 +1,15 @@
 import type { ValidationIssue } from 'cspell-lib';
 import type { Node } from 'estree';
 import type { WorkerOptions } from '../common/options.js';
+import type { NodeType } from './ASTNode.mjs';
+type Suggestions = ValidationIssue['suggestionsEx'];
 export interface Issue {
     start: number;
     end: number;
     word: string;
     severity: 'Forbidden' | 'Unknown' | 'Hint';
-    suggestions: string[] | undefined;
-    suggestionsEx: ValidationIssue['suggestionsEx'];
+    suggestions: Suggestions;
+    nodeType: NodeType;
 }
 type SpellCheckFn = typeof spellCheck;
 export type SpellCheckSyncFn = (...p: Parameters<SpellCheckFn>) => Awaited<ReturnType<SpellCheckFn>>;

package/dist/worker/spellCheck.mjs

@@ -101,7 +101,7 @@ export async function spellCheck(filename, text, root, options) {
         const range = [node.range[0] + adj, node.range[1] - adj];
         const scope = calcScope(node);
         const result = validator.checkText(range, text, scope);
-        result.forEach((issue) => reportIssue(issue));
+        result.forEach((issue) => reportIssue(issue, node.type));
     }
     function calcScope(_node) {
         // inheritance(node);
@@ -149,14 +149,13 @@ export async function spellCheck(filename, text, root, options) {
     function isObjectProperty(node) {
         return node.parent?.type === 'MemberExpression';
     }
-    function reportIssue(issue) {
+    function reportIssue(issue, nodeType) {
         const word = issue.text;
         const start = issue.offset;
         const end = issue.offset + (issue.length || issue.text.length);
-        const suggestions = issue.suggestions;
-        const suggestionsEx = issue.suggestionsEx;
+        const suggestions = normalizeSuggestions(issue.suggestionsEx, nodeType);
         const severity = issue.isFlagged ? 'Forbidden' : 'Unknown';
-        issues.push({ word, start, end, suggestions, suggestionsEx, severity });
+        issues.push({ word, start, end, nodeType, suggestions, severity });
     }
     const processors = {
         Line: checkComment,
@@ -318,3 +317,24 @@ function getTextDocument(filename, content) {
 function isCustomWordListFile(value) {
     return !!value && typeof value === 'object';
 }
+const needToAdjustSpace = {
+    Identifier: true,
+};
+const isSpecial = /[^\p{L}_0-9]/u;
+const allSpecial = /[^\p{L}_0-9]/gu;
+function normalizeSuggestions(suggestions, nodeType) {
+    if (!suggestions)
+        return undefined;
+    if (!(nodeType in needToAdjustSpace))
+        return suggestions;
+    return suggestions.map((sug) => {
+        if (!isSpecial.test(sug.word))
+            return sug;
+        const s = { ...sug };
+        s.word = s.word.replace(allSpecial, '_');
+        if (s.wordAdjustedToMatchCase) {
+            s.wordAdjustedToMatchCase = s.wordAdjustedToMatchCase.replace(allSpecial, '_');
+        }
+        return s;
+    });
+}

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.26.0",
+  "version": "6.26.2",
   "description": "CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -66,9 +66,9 @@
     "ts-json-schema-generator": "^1.2.0"
   },
   "dependencies": {
-    "cspell-lib": "6.26.0",
+    "cspell-lib": "6.26.2",
     "estree-walker": "^3.0.3",
     "synckit": "^0.8.5"
   },
-  "gitHead": "a72f603f4f1afbe237f938b1a23d7cbe2a07d86f"
+  "gitHead": "9c983b5f96c3d7b089e49178ab0b437b5eada256"
 }