fix: #3172

streetsidesoftware · Jul 1, 2022 · 33eba70 · 33eba70
1 parent 79399db
commit 33eba70
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 41 deletions.
diff --git a/packages/cspell-lib/samples/.cspell.json b/packages/cspell-lib/samples/.cspell.json
@@ -7,26 +7,13 @@
     "language": "en",
     "allowCompoundWords": false,
     // words - list of words to be always considered correct
-    "words": [
-        "gensequence",
-        "xregexp",
-        "sampletrace",
-        "findall"
-    ],
+    "words": ["gensequence", "xregexp", "sampletrace", "findall"],
     "maxNumberOfProblems": 10000,
-    "ignorePaths": [
-        "dictionaries/**",
-        "node_modules/**",
-        "vscode-extension/**",
-        ".git/**",
-        ".vscode/**"
-    ],
+    "ignorePaths": ["dictionaries/**", "node_modules/**", "vscode-extension/**", ".git/**", ".vscode/**"],
     // flagWords - list of words to be always considered incorrect
     // This is useful for offensive words and common spelling errors.
     // For example "hte" should be "the"
-    "flagWords": [
-        "hte"
-    ],
+    "flagWords": ["hte"],
     "dictionaryDefinitions": [
         {
             "name": "local words",
@@ -37,9 +24,7 @@
             "path": "./.missing.txt"
         }
     ],
-    "dictionaries": [
-        "local words"
-    ],
+    "dictionaries": ["local words"],
     "languageSettings": [
         {
             // VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
@@ -50,14 +35,9 @@
             "locale": "*",
             // By default the whole text of a file is included for spell checking
             // Adding patterns to the "includeRegExpList" to only include matching patterns
-            "includeRegExpList": [
-                "CStyleComment",
-                "string"
-            ],
+            "includeRegExpList": ["CStyleComment", "string"],
             // To exclude patterns, add them to "ignoreRegExpList"
-            "ignoreRegExpList": [
-                "/#include.*/"
-            ],
+            "ignoreRegExpList": ["/#include.*/"],
             // regex patterns than can be used with ignoreRegExpList or includeRegExpList
             // Example: "pattern": [{ "name": "mdash", "pattern": "&mdash;" }]
             // This could be included in "ignoreRegExpList": ["mdash"]
@@ -68,9 +48,7 @@
                 }
             ],
             // List of dictionaries to enable by name in `dictionaryDefinitions`
-            "dictionaries": [
-                "cpp"
-            ],
+            "dictionaries": ["cpp"],
             // Dictionary definitions can also be supplied here. They are only used iff "languageId" and "local" match.
             "dictionaryDefinitions": []
         },
@@ -83,23 +61,18 @@
     "overrides": [
         {
             "filename": "**/{*.py}",
-            "ignoreRegExpList": [
-                "/'s\\b/"
-            ]
+            "ignoreRegExpList": ["/'s\\b/"]
         },
         {
             "filename": "**/{*.c,*.cpp}",
-            "ignoreRegExpList": [
-                "/'s\\b/"
-            ]
+            "ignoreRegExpList": ["/'s\\b/"]
         },
         // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):
         {
             "language": "nl",
             "filename": "**/dutch/*.txt"
         }
     ],
-    "import": [
-        "@cspell/dict-nl-nl/cspell-ext.json"
-    ]
+    "import": ["@cspell/dict-nl-nl/cspell-ext.json", "./overrides/cspell.json"]
 }
+// cspell:ignore hte mdash
diff --git a/packages/cspell-lib/samples/overrides/cspell.json b/packages/cspell-lib/samples/overrides/cspell.json
@@ -0,0 +1,15 @@
+{
+    "overrides": [
+        {
+            "name": "Override Typescript",
+            "filename": "**/*.ts",
+            "dictionaryDefinitions": [
+                {
+                    "name": "Test Dictionary",
+                    "path": "./words.txt"
+                }
+            ],
+            "dictionaries": ["Test Dictionary"]
+        }
+    ]
+}
diff --git a/packages/cspell-lib/samples/overrides/words.txt b/packages/cspell-lib/samples/overrides/words.txt
@@ -0,0 +1,5 @@
+encrypted
+toggle
+declare
+concepts
+NeXt
diff --git a/packages/cspell-lib/src/Models/TextDocument.ts b/packages/cspell-lib/src/Models/TextDocument.ts
@@ -2,6 +2,7 @@ import { getLanguagesForBasename } from '../LanguageIds';
 import * as Uri from './Uri';
 import { TextDocument as VsTextDocument } from 'vscode-languageserver-textdocument';
 import assert from 'assert';
+import { promises as fs } from 'fs';
 
 export type DocumentUri = Uri.Uri;
 
@@ -192,4 +193,11 @@ function isTextDocumentImpl(doc: TextDocument | unknown): doc is TextDocumentImp
     return doc instanceof TextDocumentImpl;
 }
 
+export async function loadTextDocument(filename: string | DocumentUri, languageId?: string): Promise<TextDocument> {
+    const uri = Uri.toUri(filename);
+    const content = await fs.readFile(uri.fsPath, 'utf8');
+
+    return createTextDocument({ uri, languageId, content });
+}
+
 export const isTextDocument: (doc: TextDocument | unknown) => doc is TextDocument = isTextDocumentImpl;
diff --git a/packages/cspell-lib/src/Settings/DictionarySettings.ts b/packages/cspell-lib/src/Settings/DictionarySettings.ts
@@ -79,9 +79,6 @@ export function mapDictDefToInternal(
     pathToSettingsFile: string
 ): DictionaryDefinitionInternalWithSource {
     if (isDictionaryDefinitionWithSource(def)) {
-        if (def.__source !== pathToSettingsFile) {
-            throw new Error('Trying to normalize a dictionary definition with a different source.');
-        }
         return def;
     }
 

diff --git a/packages/cspell-lib/src/textValidation/determineTextDocumentSettings.test.ts b/packages/cspell-lib/src/textValidation/determineTextDocumentSettings.test.ts
@@ -0,0 +1,21 @@
+import { determineTextDocumentSettings } from './determineTextDocumentSettings';
+import * as path from 'path';
+import { loadConfig } from '../Settings';
+import { loadTextDocument } from '../Models/TextDocument';
+
+const samples = path.resolve(__dirname, '../../samples');
+const cfgPath = path.join(samples, '.cspell.json');
+const oc = expect.objectContaining;
+
+describe('determineTextDocumentSettings', () => {
+    test.each`
+        file          | configFile | expected
+        ${__filename} | ${cfgPath} | ${oc({ languageId: 'typescript' })}
+    `('determineTextDocumentSettings', async ({ file, configFile, expected }) => {
+        const cfg = await loadConfig(configFile);
+        const doc = await loadTextDocument(file);
+        const settings = determineTextDocumentSettings(doc, cfg);
+        expect(settings.dictionaries).toContain('Test Dictionary');
+        expect(settings).toEqual(expected);
+    });
+});