feat: support in doc setting LocalWords: (#485) (#486)

* feat: support in doc setting `LocalWords:` (#485)

* fix: Update snapshots and packages

* ci: add integration alexiosc/megistos

* fix: support `LocalWord:` in doc settings

* Update InDocSettings.test.ts

* Update integration-test.yml

* ci: fix lint issue

.github/workflows/integration-test.yml

@@ -22,6 +22,7 @@ jobs:
           - php/php-src
           - aws-amplify/docs
           - Azure/azure-rest-api-specs
+          - alexiosc/megistos
           - exonum/exonum
           - bitjson/typescript-starter graphql/express-graphql graphql/graphql-relay-js
           - graphql/graphql-js

.gitmodules

@@ -67,3 +67,6 @@
 [submodule "integration-tests/repositories/php/php-src"]
 	path = integration-tests/repositories/php/php-src
 	url = https://github.com/php/php-src.git
+[submodule "integration-tests/repositories/alexiosc/megistos"]
+	path = integration-tests/repositories/alexiosc/megistos
+	url = https://github.com/alexiosc/megistos.git

integration-tests/config/config.json

@@ -189,6 +189,15 @@
         "**/*.{md,c,h,php}",
         "*.{md}"
       ]
+    },
+    {
+      "path": "alexiosc/megistos",
+      "url": "https://github.com/alexiosc/megistos.git",
+      "args": [
+        "--config=../cspell.json",
+        "**/*.{md,c,h,html}",
+        "*.{md,c,h,html}"
+      ]
     }
   ]
 }

integration-tests/repositories/alexiosc/cspell.json

@@ -0,0 +1,3 @@
+{
+    "dictionaries": ["cpp"]
+}

packages/cspell-lib/src/Settings/InDocSettings.test.ts

@@ -21,8 +21,10 @@ describe('Validate InDocSettings', () => {
             'ignoreWords tooo faullts',
             'language en-US',
             'local',
+            'locale es-ES',
             'local en, nl',
-            'dictionaries lorem-ipsum'
+            'dictionaries lorem-ipsum',
+            'LocalWords: one two three',
         ]);
     });
 
@@ -53,7 +55,7 @@ describe('Validate InDocSettings', () => {
     test('tests finding words to add to dictionary', () => {
         const words = InDoc.internal.getWordsFromDocument(sampleCode);
         // we match to the end of the line, so the */ is included.
-        expect(words).toEqual(['whiteberry', 'redberry', 'lightbrown']);
+        expect(words).toEqual(['whiteberry', 'redberry', 'lightbrown', 'one', 'two', 'three']);
         expect(InDoc.getIgnoreWordsFromDocument('Hello')).toEqual([]);
     });
 
@@ -84,7 +86,7 @@ describe('Validate InDocSettings', () => {
         const ranges = TextRange.findMatchingRangesForPatterns(matches, sampleCode);
         // console.log(ranges);
         // console.log(replaceRangesWith(sampleCode, ranges));
-        expect(ranges.length).toBe(35);
+        expect(ranges.length).toBe(39);
     });
 
     test('test fetching the local for the text', () => {
@@ -122,9 +124,13 @@ const sampleCode = `
     // weirdberry can be straange.
     // cSpell:language en-US
     // cspell:local
+    // cspell:locale es-ES
     // cspell:local en, nl
 
     // cspell:dictionaries lorem-ipsum
+    // LocalWords: one two three
+    // LocalWords:four five six
+    // localwords: seven eight nine
 `;
 
 // cspell:ignore againxx
@@ -134,3 +140,5 @@ const sampleText = `
 # happydays arehere againxx
 `;
 
+// cspell:disableCompoundWords
+// cspell:ignore localwords happydays arehere

packages/cspell-lib/src/Settings/InDocSettings.ts

@@ -1,38 +1,39 @@
-import { Sequence } from 'gensequence';
+import { genSequence, Sequence } from 'gensequence';
 import * as Text from '../util/text';
 import { CSpellUserSettings } from './CSpellSettingsDef';
 import { mergeInDocSettings } from './CSpellSettingsServer';
 
 // cspell:ignore gimuy
 const regExMatchRegEx = /\/.*\/[gimuy]*/;
-const regExInFileSetting = /(?:spell-?checker|cSpell)::?\s*(.*)/gi;
+const regExInFileSettings = [
+    /(?:spell-?checker|cSpell)::?\s*(.*)/gi,
+    /(LocalWords:?\s+.*)/g,
+];
 
 export type CSpellUserSettingsKeys = keyof CSpellUserSettings;
 
 
 export function getInDocumentSettings(text: string): CSpellUserSettings {
     const settings = getPossibleInDocSettings(text)
-        .map(a => {
-            return a;
-        })
-        .map(a => a[1] || '')
         .concatMap(a => parseSettingMatch(a))
         .reduce((s, setting) => {
             return mergeInDocSettings(s, setting);
         }, { id: 'in-doc-settings' } as CSpellUserSettings);
     return settings;
 }
 
-function parseSettingMatch(possibleSetting: string): CSpellUserSettings[] {
+function parseSettingMatch(matchArray: RegExpMatchArray): CSpellUserSettings[] {
+    const [ , possibleSetting = '' ] = matchArray;
     const settingParsers: [RegExp, (m: string) => CSpellUserSettings][] = [
         [ /^(?:enable|disable)(?:allow)?CompoundWords/i, parseCompoundWords ],
         [ /^words?\s/i , parseWords ],
         [ /^ignore(?:words?)?\s/i, parseIgnoreWords ],
         [ /^ignore_?Reg_?Exp\s+.+$/i, parseIgnoreRegExp ],
         [ /^include_?Reg_?Exp\s+.+$/i, parseIncludeRegExp ],
-        [ /^(?:local|language)\s/i, parseLocal ],
-        [ /^(?:local|language)/i, parseLocal ],
+        [ /^locale?\s/i, parseLocal ],
+        [ /^language\s/i, parseLocal ],
         [ /^dictionaries\s/i, parseDictionaries ],
+        [ /^LocalWords:/, parseWords ],
     ];
 
     return settingParsers
@@ -90,7 +91,8 @@ function parseDictionaries(match: string): CSpellUserSettings {
 }
 
 function getPossibleInDocSettings(text: string): Sequence<RegExpExecArray> {
-    return Text.match(regExInFileSetting, text);
+    return genSequence(regExInFileSettings)
+        .concatMap(regexp => Text.match(regexp, text));
 }
 
 function getWordsFromDocument(text: string): string[] {