@cspell/cspell-types 6.19.2 → 6.20.0

package/dist/cjs/Parser/DictionaryDefinition.d.ts

@@ -0,0 +1,184 @@
+import type { DictionaryInformation } from './DictionaryInformation.js';
+export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+export type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
+export interface DictionaryDefinitionBase {
+    /**
+     * This is the name of a dictionary.
+     *
+     * Name Format:
+     * - Must contain at least 1 number or letter.
+     * - Spaces are allowed.
+     * - Leading and trailing space will be removed.
+     * - Names ARE case-sensitive.
+     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
+     */
+    name: DictionaryId;
+    /** Optional description. */
+    description?: string;
+    /** Replacement pairs. */
+    repMap?: ReplaceMap;
+    /** Use Compounds. */
+    useCompounds?: boolean;
+    /**
+     * Indicate that suggestions should not come from this dictionary.
+     * Words in this dictionary are considered correct, but will not be
+     * used when making spell correction suggestions.
+     *
+     * Note: if a word is suggested by another dictionary, but found in
+     * this dictionary, it will be removed from the set of
+     * possible suggestions.
+     */
+    noSuggest?: boolean;
+    /**
+     * Type of file:
+     * S - single word per line,
+     * W - each line can contain one or more words separated by space,
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
+     * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     * @default "S"
+     */
+    type?: DictionaryFileTypes;
+}
+export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
+    /** Path to the file. */
+    path: DictionaryPath;
+    /**
+     * Only for legacy dictionary definitions.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     * @hidden
+     */
+    file?: undefined;
+}
+/**
+ * Used to provide extra data related to the dictionary
+ */
+export interface DictionaryDefinitionAugmented extends DictionaryDefinitionPreferred {
+    dictionaryInformation?: DictionaryInformation;
+}
+/**
+ * Only for legacy dictionary definitions.
+ * @deprecated true
+ * @deprecationMessage Use `DictionaryDefinitionPreferred` instead.
+ */
+export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
+    /** @hidden */
+    path?: undefined;
+    /**
+     * Path to the file, only for legacy dictionary definitions.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     */
+    file: DictionaryPath;
+    /** @hidden */
+    suggestionEditCosts?: undefined;
+}
+/**
+ * @deprecated true
+ * @hidden
+ */
+export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
+    /** Path to the file, if undefined the path to the extension dictionaries is assumed. */
+    path?: FsDictionaryPath;
+    /**
+     * File name.
+     * @deprecated true
+     * @deprecationMessage Use `path` instead.
+     */
+    file: FsDictionaryPath;
+    /**
+     * Type of file:
+     * S - single word per line,
+     * W - each line can contain one or more words separated by space,
+     * C - each line is treated like code (Camel Case is allowed).
+     * Default is S.
+     * C is the slowest to load due to the need to split each line based upon code splitting rules.
+     * @default "S"
+     */
+    type?: DictionaryFileTypes;
+    /**
+     * @hidden
+     */
+    suggestionEditCosts?: undefined;
+}
+/**
+ * Specifies the scope of a dictionary.
+ */
+export type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
+/**
+ * For Defining Custom dictionaries. They are generally scoped to a
+ * `user`, `workspace`, or `folder`.
+ * When `addWords` is true, indicates that the spell checker can add words
+ * to the file.
+ * Note: only plain text files with one word per line are supported at this moment.
+ */
+export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
+    /** Path to custom dictionary text file. */
+    path: CustomDictionaryPath;
+    /**
+     * Defines the scope for when words will be added to the dictionary.
+     * Scope values: `user`, `workspace`, `folder`.
+     */
+    scope?: CustomDictionaryScope | CustomDictionaryScope[];
+    /**
+     * When `true`, let's the spell checker know that words can be added to this dictionary.
+     */
+    addWords: boolean;
+}
+/**
+ * This is the name of a dictionary.
+ *
+ * Name Format:
+ * - Must contain at least 1 number or letter.
+ * - Spaces are allowed.
+ * - Leading and trailing space will be removed.
+ * - Names ARE case-sensitive.
+ * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
+ *
+ * @pattern ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
+ */
+export type DictionaryId = string;
+export type ReplaceEntry = [string, string];
+export type ReplaceMap = ReplaceEntry[];
+/**
+ * A File System Path. Relative paths are relative to the configuration file.
+ */
+export type FsDictionaryPath = string;
+/**
+ * A File System Path to a dictionary file.
+ * @pattern ^.*\.(?:txt|trie)(?:\.gz)?$
+ */
+export type DictionaryPath = string;
+/**
+ * A File System Path to a dictionary file.
+ */
+export type CustomDictionaryPath = FsDictionaryPath;
+/**
+ * Reference to a dictionary by name.
+ * One of:
+ * - {@link DictionaryRef}
+ * - {@link DictionaryNegRef}
+ */
+export type DictionaryReference = DictionaryRef | DictionaryNegRef;
+/**
+ * This a reference to a named dictionary.
+ * It is expected to match the name of a dictionary.
+ */
+export type DictionaryRef = DictionaryId;
+/**
+ * This a negative reference to a named dictionary.
+ *
+ * It is used to exclude or include a dictionary by name.
+ *
+ * The reference starts with 1 or more `!`.
+ * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
+ * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.
+ *    Overrides `!<dictionary_name>`.
+ * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.
+ *    Overrides `!!<dictionary_name>`.
+ *
+ * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
+ */
+export type DictionaryNegRef = string;
+//# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/cjs/Parser/DictionaryInformation.d.ts

@@ -0,0 +1,210 @@
+import type { SuggestionCostsDefs } from './suggestionCostsDef.js';
+/**
+ * Use by dictionary authors to help improve the quality of suggestions
+ * given from the dictionary.
+ *
+ * Added with `v5.16.0`.
+ */
+export interface DictionaryInformation {
+    /**
+     * The locale of the dictionary.
+     * Example: `nl,nl-be`
+     */
+    locale?: string;
+    /**
+     * The alphabet to use.
+     * @default "a-zA-Z"
+     */
+    alphabet?: CharacterSet | CharacterSetCosts[];
+    /**
+     * The accent characters.
+     *
+     * Default: `"\u0300-\u0341"`
+     */
+    accents?: CharacterSet | CharacterSetCosts[];
+    /**
+     * Define edit costs.
+     */
+    costs?: EditCosts;
+    /**
+     * Used in making suggestions. The lower the value, the more likely the suggestion
+     * will be near the top of the suggestion list.
+     */
+    suggestionEditCosts?: SuggestionCostsDefs | undefined;
+    /**
+     * Used by dictionary authors
+     */
+    hunspellInformation?: HunspellInformation;
+    /**
+     * A collection of patterns to test against the suggested words.
+     * If the word matches the pattern, then the penalty is applied.
+     */
+    adjustments?: PatternAdjustment[];
+    /**
+     * An optional set of characters that can possibly be removed from a word before
+     * checking it.
+     *
+     * This is useful in languages like Arabic where Harakat accents are optional.
+     *
+     * Note: All matching characters are removed or none. Partial removal is not supported.
+     */
+    ignore?: CharacterSet;
+}
+export interface HunspellInformation {
+    /**
+     * Selected Hunspell AFF content.
+     * The content must be UTF-8
+     *
+     * Sections:
+     * - TRY
+     * - MAP
+     * - REP
+     * - KEY
+     * - ICONV
+     * - OCONV
+     *
+     * Example:
+     * ```hunspell
+     * # Comment
+     * TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+     * MAP aàâäAÀÂÄ
+     * MAP eéèêëEÉÈÊË
+     * MAP iîïyIÎÏY
+     * MAP oôöOÔÖ
+     * MAP (IJ)(IJ)
+     * ```
+     */
+    aff: HunspellAffContent;
+    /** The costs to apply when using the hunspell settings */
+    costs?: HunspellCosts;
+}
+/**
+ * Selected Hunspell AFF content.
+ * The content must be UTF-8
+ *
+ * Sections:
+ * - TRY
+ * - NO-TRY
+ * - MAP
+ * - REP
+ * - KEY
+ * - ICONV
+ * - OCONV
+ *
+ * Example:
+ * ```hunspell
+ * # Comment
+ * TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+ * NO-TRY -0123456789 # Discourage adding numbers and dashes.
+ * MAP aàâäAÀÂÄ
+ * MAP eéèêëEÉÈÊË
+ * MAP iîïyIÎÏY
+ * MAP oôöOÔÖ
+ * MAP (IJ)(IJ)
+ * ```
+ */
+type HunspellAffContent = string;
+interface HunspellCosts extends EditCosts {
+    /**
+     * The cost of inserting / deleting / or swapping any `tryChars`
+     * Defaults to `baseCosts`
+     */
+    tryCharCost?: number;
+    /**
+     * The cost of replacing or swapping any adjacent keyboard characters.
+     *
+     * This should be slightly cheaper than `tryCharCost`.
+     * @default 99
+     */
+    keyboardCost?: number;
+    /**
+     * mapSet replacement cost is the cost to substitute one character with another from
+     * the same set.
+     *
+     * Map characters are considered very similar to each other and are often
+     * the cause of simple mistakes.
+     *
+     * @default 25
+     */
+    mapCost?: number;
+    /**
+     * The cost to convert between convert pairs.
+     *
+     * The value should be slightly higher than the mapCost.
+     *
+     * @default 30
+     */
+    ioConvertCost?: number;
+    /**
+     * The cost to substitute pairs found in the replace settings.
+     *
+     * @default 75
+     */
+    replaceCosts?: number;
+}
+/**
+ *
+ */
+export interface EditCosts {
+    /**
+     * This is the base cost for making an edit.
+     * @default 100
+     */
+    baseCost?: number;
+    /**
+     * This is the cost for characters not in the alphabet.
+     * @default 110
+     */
+    nonAlphabetCosts?: number;
+    /**
+     * The extra cost incurred for changing the first letter of a word.
+     * This value should be less than `100 - baseCost`.
+     * @default 4
+     */
+    firstLetterPenalty?: number;
+    /**
+     * The cost to change capitalization.
+     * This should be very cheap, it helps with fixing capitalization issues.
+     * @default 1
+     */
+    capsCosts?: number;
+    /**
+     * The cost to add / remove an accent
+     * This should be very cheap, it helps with fixing accent issues.
+     * @default 1
+     */
+    accentCosts?: number;
+}
+/**
+ * This is a set of characters that can include `-` or `|`
+ * - `-` - indicates a range of characters: `a-c` => `abc`
+ * - `|` - is a group separator, indicating that the characters on either side
+ *    are not related.
+ */
+export type CharacterSet = string;
+export interface CharacterSetCosts {
+    /**
+     * This is a set of characters that can include `-` or `|`
+     * - `-` - indicates a range of characters: `a-c` => `abc`
+     * - `|` - is a group separator, indicating that the characters on either side
+     *    are not related.
+     */
+    characters: CharacterSet;
+    /** the cost to insert / delete / replace / swap the characters in a group */
+    cost: number;
+    /**
+     * The penalty cost to apply if the accent is used.
+     * This is used to discourage
+     */
+    penalty?: number;
+}
+export interface PatternAdjustment {
+    /** Id of the Adjustment, i.e. `short-compound` */
+    id: string;
+    /** RegExp pattern to match */
+    regexp: string | RegExp;
+    /** The amount of penalty to apply. */
+    penalty: number;
+}
+export {};
+//# sourceMappingURL=DictionaryInformation.d.ts.map

package/dist/{Parser.d.ts → cjs/Parser/Parser/index.d.ts}

@@ -123,4 +123,4 @@ export interface ScopeChain {
  */
 export type ScopeString = string;
 export type Scope = ScopeChain | ScopeString;
-//# sourceMappingURL=Parser.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/dist/{configFields.d.ts → cjs/Parser/configFields.d.ts}

@@ -1,4 +1,4 @@
-import type { CSpellUserSettings } from './CSpellSettingsDef';
+import type { CSpellUserSettings } from './CSpellSettingsDef.js';
 export type ConfigKeys = Exclude<keyof CSpellUserSettings, '$schema' | 'version' | 'id'>;
 export type CSpellUserSettingsFields = {
     [key in ConfigKeys]: key;

package/dist/cjs/Parser/index.cjs

@@ -0,0 +1,3 @@
+'use strict';
+
+//# sourceMappingURL=index.cjs.map

package/dist/{index.d.ts → cjs/Parser/index.d.ts}

@@ -1,13 +1,13 @@
-export type { CSpellUserSettingsFields } from './configFields';
-export { ConfigFields } from './configFields';
-export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter';
-export { IssueType, MessageTypes } from './CSpellReporter';
-export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef';
-export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition';
-export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation';
-export type { Feature, Features } from './features';
-export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser';
-export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef';
-export type { MappedText } from './TextMap';
-export type { TextDocumentOffset, TextOffset } from './TextOffset';
+export type { CSpellUserSettingsFields } from './configFields.js';
+export { ConfigFields } from './configFields.js';
+export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.js';
+export { IssueType, MessageTypes } from './CSpellReporter.js';
+export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
+export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.js';
+export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.js';
+export type { Feature, Features } from './features.js';
+export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser/index.js';
+export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef.js';
+export type { MappedText } from './TextMap.js';
+export type { TextDocumentOffset, TextOffset } from './TextOffset.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/TextMap.d.ts

@@ -0,0 +1,36 @@
+export type MappedText = Readonly<TransformedText>;
+export type Range = readonly [start: number, end: number];
+export interface Mapped {
+    /**
+     * `(i, j)` number pairs where
+     * - `i` is the offset in the source
+     * - `j` is the offset in the destination
+     *
+     * Example:
+     * - source text = `"caf\xe9"`
+     * - mapped text = `"café"`
+     * - map = `[3, 3, 7, 4]`, which is equivalent to `[0, 0, 3, 3, 7, 4]`
+     *   where the `[0, 0]` is unnecessary.
+     *
+     */
+    map: number[];
+}
+interface TransformedText extends PartialOrUndefined<Mapped> {
+    /**
+     * Transformed text with an optional map.
+     */
+    text: string;
+    /**
+     * The original text
+     */
+    rawText?: string | undefined;
+    /**
+     * The start and end offset of the text in the document.
+     */
+    range: Range;
+}
+type PartialOrUndefined<T> = {
+    [P in keyof T]?: T[P] | undefined;
+};
+export {};
+//# sourceMappingURL=TextMap.d.ts.map

package/dist/cjs/TextOffset.d.ts

@@ -0,0 +1,23 @@
+export interface TextOffset {
+    /**
+     * The text found at the offset. If the text has been transformed, then the length might not match `length`.
+     * Example: Original: `cafe\u0301`, text: `café`
+     */
+    text: string;
+    /**
+     * The offset into the document.
+     */
+    offset: number;
+    /**
+     * Assumed to match `text.length` if the text has not been transformed.
+     */
+    length?: number;
+}
+export interface TextDocumentOffset extends TextOffset {
+    uri?: string;
+    doc: string;
+    row: number;
+    col: number;
+    line: TextOffset;
+}
+//# sourceMappingURL=TextOffset.d.ts.map

package/dist/cjs/configFields.d.ts

@@ -0,0 +1,7 @@
+import type { CSpellUserSettings } from './CSpellSettingsDef.js';
+export type ConfigKeys = Exclude<keyof CSpellUserSettings, '$schema' | 'version' | 'id'>;
+export type CSpellUserSettingsFields = {
+    [key in ConfigKeys]: key;
+};
+export declare const ConfigFields: CSpellUserSettingsFields;
+//# sourceMappingURL=configFields.d.ts.map

package/dist/cjs/features.d.ts

@@ -0,0 +1,38 @@
+/**
+ * These are experimental features and are subject to change or removal without notice.
+ */
+export interface FeaturesExperimental {
+    /**
+     * Enable/disable using weighted suggestions.
+     */
+    'weighted-suggestions': FeatureEnableOnly;
+}
+/**
+ * These are the current set of active features
+ */
+export interface FeaturesActive {
+}
+/**
+ * These are feature settings that have been deprecated or moved elsewhere they will have no
+ * effect on the code but are here to prevent schema errors. The will get cleaned out on major versions.
+ */
+export interface FeaturesDeprecated {
+}
+/**
+ * Features are behaviors or settings that can be explicitly configured.
+ */
+export interface Features extends Partial<FeaturesActive>, Partial<FeaturesDeprecated>, Partial<FeaturesExperimental> {
+}
+export type Feature = FeatureEnableOnly | FeatureWithConfiguration;
+export type FeatureEnableOnly = boolean;
+/**
+ * Feature Configuration.
+ */
+export interface FeatureWithConfiguration {
+    enable: boolean;
+}
+export type FeatureNamesKnown = keyof Features;
+export type FeatureNamesExperimental = keyof FeaturesExperimental;
+export type FeatureNamesActive = keyof FeaturesActive;
+export type FeatureNamesDeprecated = keyof FeaturesDeprecated;
+//# sourceMappingURL=features.d.ts.map

package/dist/cjs/index.cjs

@@ -0,0 +1,68 @@
+'use strict';
+
+const ConfigFields = {
+    allowCompoundWords: 'allowCompoundWords',
+    cache: 'cache',
+    caseSensitive: 'caseSensitive',
+    description: 'description',
+    dictionaries: 'dictionaries',
+    dictionaryDefinitions: 'dictionaryDefinitions',
+    enabled: 'enabled',
+    enabledLanguageIds: 'enabledLanguageIds',
+    enableFiletypes: 'enableFiletypes',
+    enableGlobDot: 'enableGlobDot',
+    failFast: 'failFast',
+    features: 'features',
+    files: 'files',
+    flagWords: 'flagWords',
+    gitignoreRoot: 'gitignoreRoot',
+    globRoot: 'globRoot',
+    ignorePaths: 'ignorePaths',
+    ignoreRegExpList: 'ignoreRegExpList',
+    ignoreWords: 'ignoreWords',
+    import: 'import',
+    includeRegExpList: 'includeRegExpList',
+    language: 'language',
+    languageId: 'languageId',
+    languageSettings: 'languageSettings',
+    loadDefaultConfiguration: 'loadDefaultConfiguration',
+    maxDuplicateProblems: 'maxDuplicateProblems',
+    maxNumberOfProblems: 'maxNumberOfProblems',
+    minWordLength: 'minWordLength',
+    name: 'name',
+    noConfigSearch: 'noConfigSearch',
+    noSuggestDictionaries: 'noSuggestDictionaries',
+    numSuggestions: 'numSuggestions',
+    overrides: 'overrides',
+    patterns: 'patterns',
+    pnpFiles: 'pnpFiles',
+    readonly: 'readonly',
+    reporters: 'reporters',
+    showStatus: 'showStatus',
+    spellCheckDelayMs: 'spellCheckDelayMs',
+    suggestionNumChanges: 'suggestionNumChanges',
+    suggestionsTimeout: 'suggestionsTimeout',
+    useGitignore: 'useGitignore',
+    usePnP: 'usePnP',
+    userWords: 'userWords',
+    validateDirectives: 'validateDirectives',
+    words: 'words',
+    // Experimental
+    parser: 'parser',
+};
+// export const ConfigKeysNames = Object.values(ConfigKeysByField);
+
+exports.IssueType = void 0;
+(function (IssueType) {
+    IssueType[IssueType["spelling"] = 0] = "spelling";
+    IssueType[IssueType["directive"] = 1] = "directive";
+})(exports.IssueType = exports.IssueType || (exports.IssueType = {}));
+const MessageTypes = {
+    Debug: 'Debug',
+    Info: 'Info',
+    Warning: 'Warning',
+};
+
+exports.ConfigFields = ConfigFields;
+exports.MessageTypes = MessageTypes;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.d.ts

@@ -0,0 +1,13 @@
+export type { CSpellUserSettingsFields } from './configFields.js';
+export { ConfigFields } from './configFields.js';
+export type { CSpellReporter, CSpellReporterModule, DebugEmitter, ErrorEmitter, ErrorLike, Issue, MessageEmitter, MessageType, MessageTypeLookup, ProgressBase, ProgressEmitter, ProgressFileBase, ProgressFileBegin, ProgressFileComplete, ProgressItem, ProgressTypes, ResultEmitter, RunResult, SpellingErrorEmitter, } from './CSpellReporter.js';
+export { IssueType, MessageTypes } from './CSpellReporter.js';
+export type { AdvancedCSpellSettings, AdvancedCSpellSettingsWithSourceTrace, BaseSetting, CacheFormat, CacheSettings, CacheStrategy, CommandLineSettings, CSpellPackageSettings, CSpellSettings, CSpellSettingsWithSourceTrace, CSpellUserSettings, CSpellUserSettingsWithComments, ExperimentalBaseSettings, ExperimentalFileSettings, ExtendableSettings, FileSettings, FileSource, FsPath, FSPathResolvable, Glob, GlobDef, ImportFileRef, InMemorySource, LanguageId, LanguageIdMultiple, LanguageIdMultipleNeg, LanguageIdSingle, LanguageSetting, LanguageSettingFilterFields, LanguageSettingFilterFieldsDeprecated, LanguageSettingFilterFieldsPreferred, LegacySettings, LocaleId, LocalId, MergeSource, OverrideFilterFields, OverrideSettings, Pattern, PatternId, PatternRef, Plugin, PnPSettings, PredefinedPatterns, RegExpPatternDefinition, RegExpPatternList, ReporterSettings, ReportingConfiguration, Settings, SimpleGlob, Source, SuggestionsConfiguration, TrustLevel, Version, VersionLatest, VersionLegacy, WorkspaceTrustSettings, } from './CSpellSettingsDef.js';
+export type { CustomDictionaryPath, CustomDictionaryScope, DictionaryDefinition, DictionaryDefinitionAlternate, DictionaryDefinitionAugmented, DictionaryDefinitionBase, DictionaryDefinitionCustom, DictionaryDefinitionLegacy, DictionaryDefinitionPreferred, DictionaryFileTypes, DictionaryId, DictionaryNegRef, DictionaryPath, DictionaryRef, DictionaryReference, ReplaceEntry, ReplaceMap, } from './DictionaryDefinition.js';
+export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation.js';
+export type { Feature, Features } from './features.js';
+export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser/index.js';
+export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef.js';
+export type { MappedText } from './TextMap.js';
+export type { TextDocumentOffset, TextOffset } from './TextOffset.js';
+//# sourceMappingURL=index.d.ts.map