@cspell/eslint-plugin 6.23.1 → 6.25.0

package/README.md

@@ -23,6 +23,12 @@ This plugin is still in active development as part of the CSpell suite of tools
 
 ````ts
 interface Options {
+  /**
+   * Automatically fix common mistakes.
+   * This is only possible if a single preferred suggestion is available.
+   * @default false
+   */
+  autoFix: boolean;
   /**
    * Number of spelling suggestions to make.
    * @default 8
@@ -99,11 +105,37 @@ Example:
 {
   "plugins": ["@cspell"],
   "rules": {
-    "@cspell/spellchecker": ["warn", { "checkComments": false }]
+    "@cspell/spellchecker": ["warn", { "checkComments": false, "autoFix": true }]
   }
 }
 ```
 
+## `autoFix`
+
+When enabled, `autoFix` corrects any spelling issues that have a single "preferred" suggestion. It attempts to match
+case and style, but it cannot guarantee correctness of code.
+
+### Preferred Suggestions
+
+CSpell offers the ability to flag words as incorrect and to provide suggestions.
+
+**`cspell.config.yaml`**
+
+```yaml
+words:
+  - allowlist
+flagWords:
+  - blacklist->allowlist
+suggestWords:
+  - colour->color
+```
+
+With this configuration, `blacklist` is flagged as forbidden and `allowlist` is the "preferred" suggestion. When `autoFix` is enabled, all instances of `blacklist` will be replaced with `allowlist`.
+
+When spell checking, if `colour` is not in one of the dictionaries, then `color` will be offered as the preferred suggestion. `suggestWords` are used to provide preferred suggestions, but will not flag any words as incorrect.
+
+CSpell will match case, but not word stems. `blacklist` and `Blacklist` will get replaced, but not `blacklists`.
+
 ## In Combination with CSpell
 
 Due to the nature of how files are parsed, the `cspell` command line tool and this ESLint plugin will give different results.
@@ -116,8 +148,32 @@ Differences:
 
 - The CSpell ESLint plugin uses the [AST](https://dev.to/akshay9677/what-the-heck-is-an-abstract-syntax-tree-ast--3kk5) (a way to identify the meaning of the individual parts of your code) provided by ESLint to only check literal strings, identifiers, and comments. See [Options](#options) on selecting what to check.
 
-Example spell checked with ESLint CSpell Plugin:
-<img width="749" alt="image" src="https://user-images.githubusercontent.com/3740137/216295162-38ddf6a0-3873-4e48-b3a5-65fd421dae94.png">
+Example spell checked with ESLint CSpell Plugin: <img width="749" alt="image" src="https://user-images.githubusercontent.com/3740137/216295162-38ddf6a0-3873-4e48-b3a5-65fd421dae94.png">
+
+Example spell checked with just `cspell`: <img width="744" alt="image" src="https://user-images.githubusercontent.com/3740137/216295368-024c1065-2432-4d10-b204-7eb0589695e6.png">
+
+## CSpell for Enterprise
+
+<!--- @@inject: ../../static/tidelift.md --->
+
+Available as part of the Tidelift Subscription.
+
+The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
+
+<!--- @@inject-end: ../../static/tidelift.md --->
+
+<!--- @@inject: ../../static/footer.md --->
+
+<br/>
+
+---
+
+<p align="center">
+Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
+<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
+</a>
+</p>
+
+<!--- @@inject-end: ../../static/footer.md --->
 
-Example spell checked with just `cspell`:
-<img width="744" alt="image" src="https://user-images.githubusercontent.com/3740137/216295368-024c1065-2432-4d10-b204-7eb0589695e6.png">
+<!--- cspell:ignore colour --->

package/dist/_auto_generated_/options.schema.json

@@ -3,6 +3,11 @@
     "additionalProperties": false,
     "definitions": {},
     "properties": {
+        "autoFix": {
+            "default": false,
+            "description": "Automatically fix common mistakes. This is only possible if a single preferred suggestion is available.",
+            "type": "boolean"
+        },
         "checkComments": {
             "default": true,
             "description": "Spell check comments",
@@ -78,7 +83,8 @@
     },
     "required": [
         "numSuggestions",
-        "generateSuggestions"
+        "generateSuggestions",
+        "autoFix"
     ],
     "type": "object"
 }

package/dist/common/options.d.ts

@@ -9,6 +9,12 @@ export interface Options extends Check {
      * @default true
      */
     generateSuggestions: boolean;
+    /**
+     * Automatically fix common mistakes.
+     * This is only possible if a single preferred suggestion is available.
+     * @default false
+     */
+    autoFix: boolean;
     /**
      * Output debug logs
      * @default false

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

@@ -12,8 +12,7 @@ const spellCheck = (0, synckit_1.createSyncFn)(require.resolve('../worker/worker
 const messages = {
     wordUnknown: 'Unknown word: "{{word}}"',
     wordForbidden: 'Forbidden word: "{{word}}"',
-    suggestWord: '{{word}}',
-    addWordToDictionary: 'Add "{{word}}" to {{dictionary}}',
+    suggestWord: '{{word}}{{preferred}}',
 };
 const meta = {
     docs: {
@@ -23,6 +22,7 @@ const meta = {
     },
     messages,
     hasSuggestions: true,
+    fixable: 'code',
     schema: [schema],
 };
 let isDebugMode = false;
@@ -31,8 +31,12 @@ function log(...args) {
         return;
     console.log(...args);
 }
+function nullFix() {
+    return null;
+}
 function create(context) {
     const options = (0, defaultCheckOptions_1.normalizeOptions)(context.options[0], context.getCwd());
+    const autoFix = options.autoFix;
     isDebugMode = options.debugMode || false;
     isDebugMode && logContext(context);
     function reportIssue(issue) {
@@ -48,8 +52,10 @@ function create(context) {
         function fixFactory(word) {
             return (fixer) => fixer.replaceTextRange([start, end], word);
         }
-        function createSug(word) {
-            const data = { word };
+        function createSug(sug) {
+            const word = sug.wordAdjustedToMatchCase || sug.word;
+            const preferred = sug.isPreferred ? '*' : '';
+            const data = { word, preferred };
             const messageId = 'suggestWord';
             return {
                 messageId,
@@ -58,13 +64,20 @@ function create(context) {
             };
         }
         log('Suggestions: %o', issue.suggestions);
-        const suggestions = issue.suggestions?.map(createSug);
+        const fixable = issue.suggestionsEx?.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 suggest = suggestions;
         const des = {
             messageId,
             data,
             loc,
             suggest,
+            fix,
         };
         context.report(des);
     }

package/dist/plugin/defaultCheckOptions.js

@@ -16,6 +16,7 @@ exports.defaultOptions = {
     numSuggestions: 8,
     generateSuggestions: true,
     debugMode: false,
+    autoFix: false,
 };
 function normalizeOptions(opts, cwd) {
     const options = Object.assign({}, exports.defaultOptions, opts || {}, { cwd });

package/dist/worker/spellCheck.d.mts

@@ -1,3 +1,4 @@
+import type { ValidationIssue } from 'cspell-lib';
 import type { Node } from 'estree';
 import type { WorkerOptions } from '../common/options.js';
 export interface Issue {
@@ -6,6 +7,7 @@ export interface Issue {
     word: string;
     severity: 'Forbidden' | 'Unknown' | 'Hint';
     suggestions: string[] | undefined;
+    suggestionsEx: ValidationIssue['suggestionsEx'];
 }
 type SpellCheckFn = typeof spellCheck;
 export type SpellCheckSyncFn = (...p: Parameters<SpellCheckFn>) => Awaited<ReturnType<SpellCheckFn>>;

package/dist/worker/spellCheck.mjs

@@ -154,8 +154,9 @@ export async function spellCheck(filename, text, root, options) {
         const start = issue.offset;
         const end = issue.offset + (issue.length || issue.text.length);
         const suggestions = issue.suggestions;
+        const suggestionsEx = issue.suggestionsEx;
         const severity = issue.isFlagged ? 'Forbidden' : 'Unknown';
-        issues.push({ word, start, end, suggestions, severity });
+        issues.push({ word, start, end, suggestions, suggestionsEx, severity });
     }
     const processors = {
         Line: checkComment,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.23.1",
+  "version": "6.25.0",
   "description": "CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -54,21 +54,21 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@types/eslint": "^8.21.0",
+    "@types/eslint": "^8.21.1",
     "@types/estree": "^1.0.0",
     "@types/node": "^18.13.0",
-    "@typescript-eslint/parser": "^5.51.0",
-    "@typescript-eslint/types": "^5.51.0",
-    "@typescript-eslint/typescript-estree": "^5.51.0",
+    "@typescript-eslint/parser": "^5.52.0",
+    "@typescript-eslint/types": "^5.52.0",
+    "@typescript-eslint/typescript-estree": "^5.52.0",
     "eslint": "^8.34.0",
     "eslint-plugin-react": "^7.32.2",
     "mocha": "^10.2.0",
     "ts-json-schema-generator": "^1.2.0"
   },
   "dependencies": {
-    "cspell-lib": "6.23.1",
+    "cspell-lib": "6.25.0",
     "estree-walker": "^3.0.3",
     "synckit": "^0.8.5"
   },
-  "gitHead": "dace8b0625beb2766565f47bc813dc0a45480dc0"
+  "gitHead": "fd7541605e07c43887191097d58ab58d87fac8fd"
 }