fix: Do not allow nested Parser functions. (#3155)

Parser references must be strings.
streetsidesoftware · Jun 29, 2022 · 8083c95 · 8083c95
1 parent f5b7f8e
commit 8083c95
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 4 deletions.
diff --git a/packages/cspell-lib/api/api.d.ts b/packages/cspell-lib/api/api.d.ts
@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Glob, CSpellSettingsWithSourceTrace, ReplaceMap, DictionaryInformation, DictionaryDefinitionPreferred, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, TextOffset, TextDocumentOffset, PnPSettings as PnPSettings$1, ImportFileRef, CSpellUserSettings, MappedText, ParsedText, LocaleId, CSpellSettings } from '@cspell/cspell-types';
+import { Glob, CSpellSettingsWithSourceTrace, ReplaceMap, DictionaryInformation, Parser, DictionaryDefinitionPreferred, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, TextOffset, TextDocumentOffset, PnPSettings as PnPSettings$1, ImportFileRef, CSpellUserSettings, MappedText, ParsedText, LocaleId, CSpellSettings } from '@cspell/cspell-types';
 export * from '@cspell/cspell-types';
 import { CompoundWordsMethod, SuggestionResult, SuggestionCollector, WeightMap } from 'cspell-trie-lib';
 export { CompoundWordsMethod, SuggestionCollector, SuggestionResult } from 'cspell-trie-lib';
@@ -227,6 +227,7 @@ interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTrace, 'di
     dictionaryDefinitions?: DictionaryDefinitionInternal[];
 }
 interface CSpellSettingsInternalFinalized extends CSpellSettingsInternal {
+    parserFn: Parser | undefined;
     finalized: true;
     ignoreRegExpList: RegExp[];
     includeRegExpList: RegExp[];

diff --git a/packages/cspell-lib/src/Models/CSpellSettingsInternalDef.ts b/packages/cspell-lib/src/Models/CSpellSettingsInternalDef.ts
@@ -3,6 +3,7 @@ import {
     DictionaryDefinitionAugmented,
     DictionaryDefinitionCustom,
     DictionaryDefinitionPreferred,
+    Parser,
 } from '@cspell/cspell-types';
 import { WeightMap } from 'cspell-trie-lib';
 import { OptionalOrUndefined } from '../util/types';
@@ -16,6 +17,7 @@ export interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTra
 }
 
 export interface CSpellSettingsInternalFinalized extends CSpellSettingsInternal {
+    parserFn: Parser | undefined;
     finalized: true;
     ignoreRegExpList: RegExp[];
     includeRegExpList: RegExp[];

diff --git a/packages/cspell-lib/src/Settings/CSpellSettingsServer.ts b/packages/cspell-lib/src/Settings/CSpellSettingsServer.ts
@@ -274,7 +274,7 @@ function _finalizeSettings(settings: CSpellSettingsI): CSpellSettingsInternalFin
         finalized: true,
         ignoreRegExpList: resolvePatterns(settings.ignoreRegExpList, settings.patterns),
         includeRegExpList: resolvePatterns(settings.includeRegExpList, settings.patterns),
-        parser: resolveParser(settings),
+        parserFn: resolveParser(settings),
     };
 
     finalized.name = 'Finalized ' + (finalized.name || '');

diff --git a/packages/cspell-lib/src/textValidation/docValidator.ts b/packages/cspell-lib/src/textValidation/docValidator.ts
@@ -322,7 +322,7 @@ export class DocumentValidator {
 
     private _parse(): Iterable<ParsedText> {
         assert(this._preparations, ERROR_NOT_PREPARED);
-        const parser = this._preparations.finalSettings.parser;
+        const parser = this._preparations.finalSettings.parserFn;
         if (typeof parser !== 'object') return this.defaultParser();
         return parser.parse(this.document.text, this.document.uri.path).parsedTexts;
     }

diff --git a/packages/cspell-types/src/CSpellSettingsDef.ts b/packages/cspell-types/src/CSpellSettingsDef.ts
@@ -988,7 +988,7 @@ export interface ExperimentalBaseSettings {
      * @experimental
      * @version 6.2.0
      */
-    parser?: ParserName | Parser | undefined;
+    parser?: ParserName | undefined;
 }
 
 /**