fix: Display suggestions -- regression (#976)

streetsidesoftware · Feb 19, 2021 · e3970c7 · e3970c7
1 parent ca1b7c2
commit e3970c7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/packages/cspell-lib/src/spellCheckFile.ts b/packages/cspell-lib/src/spellCheckFile.ts
@@ -10,11 +10,11 @@ import {
     mergeSettings,
     searchForConfig,
 } from './Settings';
-import { validateText, ValidationIssue } from './validator';
+import { validateText, ValidateTextOptions, ValidationIssue } from './validator';
 import * as path from 'path';
 import { combineTextAndLanguageSettings } from './Settings/TextDocumentSettings';
 
-export interface SpellCheckFileOptions {
+export interface SpellCheckFileOptions extends ValidateTextOptions {
     /**
      * Optional path to a configuration file.
      * If given, it will be used instead of searching for a configuration file.
@@ -148,8 +148,10 @@ async function spellCheckFullDocument(
     const docSettings = determineFinalDocumentSettings(document, config);
 
     const shouldCheck = docSettings.settings.enabled ?? true;
+    const { generateSuggestions, numSuggestions } = options;
+    const validateOptions = { generateSuggestions, numSuggestions };
 
-    const issues = shouldCheck ? await validateText(document.text, docSettings.settings) : [];
+    const issues = shouldCheck ? await validateText(document.text, docSettings.settings, validateOptions) : [];
 
     const result: SpellCheckFileResult = {
         document,

diff --git a/packages/cspell-lib/src/validator.ts b/packages/cspell-lib/src/validator.ts
@@ -15,7 +15,9 @@ export interface ValidationIssue extends Text.TextOffset {
 }
 
 export interface ValidateTextOptions {
+    /** Generate suggestions where there are spelling issues. */
     generateSuggestions?: boolean;
+    /** The number of suggestions to generate. The higher the number the longer it takes. */
     numSuggestions?: number;
 }
 

diff --git a/packages/cspell/src/lint.ts b/packages/cspell/src/lint.ts
@@ -51,7 +51,8 @@ export function runLint(cfg: CSpellApplicationConfiguration): Promise<RunResult>
             MessageTypes.Info
         );
         try {
-            const r = await cspell.spellCheckDocument(doc, {}, configInfo.config);
+            const validateOptions = { generateSuggestions: cfg.options.showSuggestions, numSuggestions: 5 };
+            const r = await cspell.spellCheckDocument(doc, validateOptions, configInfo.config);
             spellResult = r;
             result.processed = r.checked;
             result.issues = cspell.Text.calculateTextDocumentOffsets(filename, text, r.issues).map(mapIssue);