cspell 6.29.2 → 6.30.0

package/README.md

@@ -155,6 +155,7 @@ Options:
   --relative                   Issues are displayed relative to root.
   --show-context               Show the surrounding text around an issue.
   --show-suggestions           Show spelling suggestions.
+  --no-show-suggestions        Do not show spelling suggestions or fixes.
   --no-must-find-files         Do not error if no files are found.
   --cache                      Use cache to only check changed files.
   --no-cache                   Do not use cache.

package/dist/cjs/cli-reporter.js

@@ -31,7 +31,8 @@ const chalk_1 = __importDefault(require("chalk"));
 const cspell_lib_1 = require("cspell-lib");
 const path = __importStar(require("path"));
 const uri_cjs_1 = require("../lib/uri.cjs");
-const templateIssue = `{green $filename}:{yellow $row:$col} - $message ({red $text})`;
+const templateIssue = `{green $filename}:{yellow $row:$col} - $message ({red $text}) $quickFix`;
+const templateIssueNoFix = `{green $filename}:{yellow $row:$col} - $message ({red $text})`;
 const templateIssueWithSuggestions = `{green $filename}:{yellow $row:$col} - $message ({red $text}) Suggestions: {yellow [$suggestions]}`;
 const templateIssueWithContext = `{green $filename}:{yellow $row:$col} $padRowCol- $message ({red $text})$padContext -- {gray $contextLeft}{red {underline $text}}{gray $contextRight}`;
 const templateIssueWithContextWithSuggestions = `{green $filename}:{yellow $row:$col} $padRowCol- $message ({red $text})$padContext -- {gray $contextLeft}{red {underline $text}}{gray $contextRight}\n\t Suggestions: {yellow [$suggestions]}`;
@@ -112,7 +113,9 @@ function getReporter(options) {
                     : templateIssueWithContext
                 : options.showSuggestions
                     ? templateIssueWithSuggestions
-                    : templateIssue;
+                    : options.showSuggestions === false
+                        ? templateIssueNoFix
+                        : templateIssue;
     const { fileGlobs, silent, summary, issues, progress, verbose, debug } = options;
     const emitters = {
         Debug: !silent && debug ? (s) => console.info(chalk_1.default.cyan(s)) : nullEmitter,
@@ -181,9 +184,10 @@ function formatIssue(templateStr, issue, maxIssueTextWidth) {
         $suggestions: suggestions,
         $text: text,
         $uri: uri,
+        $quickFix: formatQuickFix(issue),
     };
     const t = template(templateStr.replace(/\$message/g, message));
-    return substitute((0, chalk_1.default)(t), substitutions);
+    return substitute((0, chalk_1.default)(t), substitutions).trimEnd();
 }
 function formatSuggestions(issue) {
     if (issue.suggestionsEx) {
@@ -198,6 +202,17 @@ function formatSuggestions(issue) {
     }
     return '';
 }
+function formatQuickFix(issue) {
+    if (!issue.suggestionsEx?.length)
+        return '';
+    const preferred = issue.suggestionsEx
+        .filter((sug) => sug.isPreferred)
+        .map((sug) => sug.wordAdjustedToMatchCase || sug.word);
+    if (!preferred.length)
+        return '';
+    const fixes = preferred.map((w) => chalk_1.default.italic(chalk_1.default.yellow(w)));
+    return `fix: (${fixes.join(', ')})`;
+}
 class TS extends Array {
     constructor(s) {
         super(s);

package/dist/cjs/commandLint.js

@@ -99,6 +99,7 @@ function commandLint(prog) {
         .option('--relative', 'Issues are displayed relative to root.')
         .option('--show-context', 'Show the surrounding text around an issue.')
         .option('--show-suggestions', 'Show spelling suggestions.')
+        .addOption(new commander_1.Option('--no-show-suggestions', 'Do not show spelling suggestions or fixes.').default(undefined))
         .addOption(new commander_1.Option('--must-find-files', 'Error if no files are found.').default(true).hideHelp())
         .option('--no-must-find-files', 'Do not error if no files are found.')
         // The following options are planned features

package/dist/esm/cli-reporter.mjs

@@ -2,7 +2,8 @@ import chalk from 'chalk';
 import { isSpellingDictionaryLoadError } from 'cspell-lib';
 import * as path from 'path';
 import { URI } from '../lib/uri.cjs';
-const templateIssue = `{green $filename}:{yellow $row:$col} - $message ({red $text})`;
+const templateIssue = `{green $filename}:{yellow $row:$col} - $message ({red $text}) $quickFix`;
+const templateIssueNoFix = `{green $filename}:{yellow $row:$col} - $message ({red $text})`;
 const templateIssueWithSuggestions = `{green $filename}:{yellow $row:$col} - $message ({red $text}) Suggestions: {yellow [$suggestions]}`;
 const templateIssueWithContext = `{green $filename}:{yellow $row:$col} $padRowCol- $message ({red $text})$padContext -- {gray $contextLeft}{red {underline $text}}{gray $contextRight}`;
 const templateIssueWithContextWithSuggestions = `{green $filename}:{yellow $row:$col} $padRowCol- $message ({red $text})$padContext -- {gray $contextLeft}{red {underline $text}}{gray $contextRight}\n\t Suggestions: {yellow [$suggestions]}`;
@@ -83,7 +84,9 @@ export function getReporter(options) {
                     : templateIssueWithContext
                 : options.showSuggestions
                     ? templateIssueWithSuggestions
-                    : templateIssue;
+                    : options.showSuggestions === false
+                        ? templateIssueNoFix
+                        : templateIssue;
     const { fileGlobs, silent, summary, issues, progress, verbose, debug } = options;
     const emitters = {
         Debug: !silent && debug ? (s) => console.info(chalk.cyan(s)) : nullEmitter,
@@ -151,9 +154,10 @@ function formatIssue(templateStr, issue, maxIssueTextWidth) {
         $suggestions: suggestions,
         $text: text,
         $uri: uri,
+        $quickFix: formatQuickFix(issue),
     };
     const t = template(templateStr.replace(/\$message/g, message));
-    return substitute(chalk(t), substitutions);
+    return substitute(chalk(t), substitutions).trimEnd();
 }
 function formatSuggestions(issue) {
     if (issue.suggestionsEx) {
@@ -168,6 +172,17 @@ function formatSuggestions(issue) {
     }
     return '';
 }
+function formatQuickFix(issue) {
+    if (!issue.suggestionsEx?.length)
+        return '';
+    const preferred = issue.suggestionsEx
+        .filter((sug) => sug.isPreferred)
+        .map((sug) => sug.wordAdjustedToMatchCase || sug.word);
+    if (!preferred.length)
+        return '';
+    const fixes = preferred.map((w) => chalk.italic(chalk.yellow(w)));
+    return `fix: (${fixes.join(', ')})`;
+}
 class TS extends Array {
     constructor(s) {
         super(s);

package/dist/esm/commandLint.mjs

@@ -73,6 +73,7 @@ export function commandLint(prog) {
         .option('--relative', 'Issues are displayed relative to root.')
         .option('--show-context', 'Show the surrounding text around an issue.')
         .option('--show-suggestions', 'Show spelling suggestions.')
+        .addOption(new CommanderOption('--no-show-suggestions', 'Do not show spelling suggestions or fixes.').default(undefined))
         .addOption(new CommanderOption('--must-find-files', 'Error if no files are found.').default(true).hideHelp())
         .option('--no-must-find-files', 'Do not error if no files are found.')
         // The following options are planned features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell",
-  "version": "6.29.2",
+  "version": "6.30.0",
   "description": "A Spelling Checker for Code!",
   "funding": "https://github.com/streetsidesoftware/cspell?sponsor=1",
   "bin": {
@@ -88,14 +88,14 @@
   },
   "homepage": "https://streetsidesoftware.github.io/cspell/",
   "dependencies": {
-    "@cspell/cspell-pipe": "6.29.2",
-    "@cspell/dynamic-import": "6.29.2",
+    "@cspell/cspell-pipe": "6.30.0",
+    "@cspell/dynamic-import": "6.30.0",
     "chalk": "^4.1.2",
     "commander": "^10.0.0",
-    "cspell-gitignore": "6.29.2",
-    "cspell-glob": "6.29.2",
-    "cspell-io": "6.29.2",
-    "cspell-lib": "6.29.2",
+    "cspell-gitignore": "6.30.0",
+    "cspell-glob": "6.30.0",
+    "cspell-io": "6.30.0",
+    "cspell-lib": "6.30.0",
     "fast-glob": "^3.2.12",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
@@ -109,8 +109,8 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@cspell/cspell-json-reporter": "6.29.2",
-    "@cspell/cspell-types": "6.29.2",
+    "@cspell/cspell-json-reporter": "6.30.0",
+    "@cspell/cspell-types": "6.30.0",
     "@types/file-entry-cache": "^5.0.2",
     "@types/glob": "^8.1.0",
     "@types/imurmurhash": "^0.1.1",
@@ -119,5 +119,5 @@
     "micromatch": "^4.0.5",
     "minimatch": "^7.4.2"
   },
-  "gitHead": "fae497508ec03795dfe0e0b70ea80cdf3d7be5a5"
+  "gitHead": "9af8c211fdeeb58e2d7a2be0e72405a23fe954cc"
 }