fix: Make sure flaggedWords are always checked. (#1935)

* Make sure flaggedWords are always checked. Fix: #1895 * ignore deliberate misspelling * Update English dictionary
streetsidesoftware · Nov 1, 2021 · dfbfddd · dfbfddd
1 parent f2e9380
commit dfbfddd
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 19 deletions.
diff --git a/docs/configuration/index.md b/docs/configuration/index.md
@@ -30,6 +30,8 @@ Or you can specify a path to a config file with the `--config <path>` argument o
 
 #### Example `cspell.json` file
 
+<!--- cspell:ignore hte -->
+
 ```javascript
 // cSpell Settings
 {

diff --git a/packages/cspell-bundled-dicts/package-lock.json b/packages/cspell-bundled-dicts/package-lock.json
diff --git a/packages/cspell-bundled-dicts/package.json b/packages/cspell-bundled-dicts/package.json
@@ -55,7 +55,7 @@
     "@cspell/dict-dotnet": "^1.0.32",
     "@cspell/dict-elixir": "^1.0.26",
     "@cspell/dict-en-gb": "^1.1.33",
-    "@cspell/dict-en_us": "^2.1.2",
+    "@cspell/dict-en_us": "^2.1.3",
     "@cspell/dict-filetypes": "^2.0.1",
     "@cspell/dict-fonts": "^1.0.14",
     "@cspell/dict-fullstack": "^2.0.4",

diff --git a/packages/cspell-lib/src/SpellingDictionary/Dictionaries.test.ts b/packages/cspell-lib/src/SpellingDictionary/Dictionaries.test.ts
@@ -54,7 +54,7 @@ describe('Validate getDictionary', () => {
         expect(dict.has(word, opts)).toBe(expected);
     });
 
-    // cspell:ignore zeromq
+    // cspell:ignore zeromq hte
     test.each`
         word        | expected
         ${'zero'}   | ${{ found: false, forbidden: false, noSuggest: false }}

diff --git a/packages/cspell-lib/src/textValidator.test.ts b/packages/cspell-lib/src/textValidator.test.ts
@@ -209,14 +209,18 @@ describe('Validate textValidator functions', () => {
     });
 
     test.each`
-        text        | ignoreWords   | expected
-        ${'red'}    | ${[]}         | ${[]}
-        ${'color'}  | ${[]}         | ${[ov({ text: 'color', isFound: false })]}
-        ${'colour'} | ${[]}         | ${[ov({ text: 'colour', isFlagged: true })]}
-        ${'colour'} | ${['colour']} | ${[]}
-    `('Validate forbidden words', ({ text, ignoreWords, expected }) => {
+        text                           | ignoreWords   | flagWords       | expected
+        ${'red'}                       | ${[]}         | ${undefined}    | ${[]}
+        ${'color'}                     | ${[]}         | ${undefined}    | ${[ov({ text: 'color', isFound: false })]}
+        ${'colour'}                    | ${[]}         | ${undefined}    | ${[ov({ text: 'colour', isFlagged: true })]}
+        ${'colour'}                    | ${['colour']} | ${undefined}    | ${[]}
+        ${'The ant ate the antelope.'} | ${[]}         | ${['fbd']}      | ${[]}
+        ${'The ant ate the antelope.'} | ${[]}         | ${['ate']}      | ${[ov({ text: 'ate', isFlagged: true })]}
+        ${'theANT_ateThe_antelope.'}   | ${[]}         | ${['ate']}      | ${[ov({ text: 'ate', isFlagged: true })]}
+        ${'The ant ate the antelope.'} | ${[]}         | ${['antelope']} | ${[ov({ text: 'antelope', isFlagged: true })]}
+    `('Validate forbidden words', ({ text, ignoreWords, expected, flagWords }) => {
         const dict = getSpellingDictionaryCollectionSync({ ignoreWords });
-        const result = [...validateText(text, dict, { ignoreCase: false })];
+        const result = [...validateText(text, dict, { ignoreCase: false, flagWords })];
         expect(result).toEqual(expected);
     });
 });

diff --git a/packages/cspell-lib/src/textValidator.ts b/packages/cspell-lib/src/textValidator.ts
@@ -153,12 +153,9 @@ function lineValidator(dict: SpellingDictionary, options: ValidationOptions): Li
 
             const codeWordResults = Text.extractWordsFromCodeTextOffset(vr)
                 .filter(filterAlreadyChecked)
-                .filter(rememberFilter((wo) => wo.text.length >= minWordLength))
                 .map((t) => ({ ...t, line: vr.line }))
-                .map((wo) => {
-                    const vr: ValidationResult = wo;
-                    return vr;
-                })
+                .map(checkFlagWords)
+                .filter(rememberFilter((wo) => wo.text.length >= minWordLength || !!wo.isFlagged))
                 .map((wo) => (wo.isFlagged ? wo : checkWord(wo, hasWordOptions)))
                 .filter(rememberFilter((wo) => wo.isFlagged || !wo.isFound))
                 .filter(rememberFilter((wo) => !RxPat.regExRepeatedChar.test(wo.text))) // Filter out any repeated characters like xxxxxxxxxx
@@ -180,9 +177,9 @@ function lineValidator(dict: SpellingDictionary, options: ValidationOptions): Li
         function checkPossibleWords(possibleWord: TextOffset) {
             const mismatches: ValidationResult[] = Text.extractWordsFromTextOffset(possibleWord)
                 .filter(filterAlreadyChecked)
-                .filter(rememberFilter((wo) => wo.text.length >= minWordLength))
                 .map((wo) => ({ ...wo, line: lineSegment }))
                 .map(checkFlagWords)
+                .filter(rememberFilter((wo) => wo.text.length >= minWordLength || !!wo.isFlagged))
                 .concatMap(checkFullWord)
                 .toArray();
             if (mismatches.length) {

diff --git a/packages/cspell-lib/src/trace.test.ts b/packages/cspell-lib/src/trace.test.ts
@@ -25,7 +25,7 @@ describe('Verify trace', () => {
         );
     });
 
-    // cspell:ignore *error* *code*
+    // cspell:ignore *error* *code* hte
     test.each`
         word           | languageId   | locale       | ignoreCase | allowCompoundWords | dictName           | dictActive | found    | forbidden | noSuggest | foundWord
         ${'apple'}     | ${undefined} | ${undefined} | ${true}    | ${undefined}       | ${'en_us'}         | ${true}    | ${true}  | ${false}  | ${false}  | ${'apple'}

diff --git a/packages/cspell-lib/src/validator.test.ts b/packages/cspell-lib/src/validator.test.ts
@@ -239,6 +239,7 @@ const sampleWords = [
     'worm',
 ];
 
+// cspell:ignore hte
 const flagWords = ['hte', 'flagged', 'ignored'];
 // cspell:ignore behaviour
 const rejectWords = ['!colour', '!behaviour', '!favour'];