/
CSpellSettingsInternalDef.ts
52 lines (45 loc) · 1.83 KB
/
CSpellSettingsInternalDef.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
import {
CSpellSettingsWithSourceTrace,
DictionaryDefinitionAugmented,
DictionaryDefinitionCustom,
DictionaryDefinitionPreferred,
} from '@cspell/cspell-types';
import { WeightMap } from 'cspell-trie-lib';
import { OptionalOrUndefined } from '../util/types';
import { clean } from '../util/util';
export const SymbolCSpellSettingsInternal = Symbol('CSpellSettingsInternal');
export interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTrace, 'dictionaryDefinitions'> {
[SymbolCSpellSettingsInternal]: true;
dictionaryDefinitions?: DictionaryDefinitionInternal[];
}
type DictionaryDefinitionCustomUniqueFields = Omit<DictionaryDefinitionCustom, keyof DictionaryDefinitionPreferred>;
export interface DictionaryDefinitionInternal
extends Readonly<DictionaryDefinitionPreferred>,
Readonly<Partial<DictionaryDefinitionCustomUniqueFields>>,
Readonly<DictionaryDefinitionAugmented> {
/**
* Optional weight map used to improve suggestions.
*/
readonly weightMap?: WeightMap | undefined;
/** The path to the config file that contains this dictionary definition */
readonly __source?: string | undefined;
}
export interface DictionaryDefinitionInternalWithSource extends DictionaryDefinitionInternal {
readonly __source: string;
}
export function createCSpellSettingsInternal(
parts: OptionalOrUndefined<Partial<CSpellSettingsInternal>> = {}
): CSpellSettingsInternal {
return clean({
...parts,
[SymbolCSpellSettingsInternal]: true,
});
}
export function isCSpellSettingsInternal(
cs:
| CSpellSettingsInternal
| CSpellSettingsWithSourceTrace
| OptionalOrUndefined<CSpellSettingsInternal | CSpellSettingsWithSourceTrace>
): cs is CSpellSettingsInternal {
return !!(<CSpellSettingsInternal>cs)[SymbolCSpellSettingsInternal];
}