@cspell/cspell-types 7.0.2 → 7.2.0

package/dist/esm/DictionaryDefinition.d.mts

@@ -1,219 +0,0 @@
-import type { DictionaryInformation } from './DictionaryInformation.mjs';
-import type { InlineDictionary } from './InlineDictionary.mjs';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | 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;
-}
-/**
- * Inline Dictionary Definition
- *
- * All words are defined inline.
- */
-interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, InlineDictionary {
-    /**
-     * Not used
-     * @hidden
-     */
-    path?: undefined;
-    /**
-     * Note used
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
-     * @hidden
-     */
-    file?: undefined;
-}
-export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
-    words: string[];
-}
-export interface DictionaryDefinitionInlineFlagWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'flagWords'>> {
-    flagWords: string[];
-}
-export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'ignoreWords'>> {
-    ignoreWords: string[];
-}
-/**
- * Inline Dictionary Definitions
- * @version 6.23.0
- */
-export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
-/**
- * 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;
-export {};
-//# sourceMappingURL=DictionaryDefinition.d.mts.map

package/dist/esm/DictionaryDefinition.d.ts

@@ -1,219 +0,0 @@
-import type { DictionaryInformation } from './DictionaryInformation.js';
-import type { InlineDictionary } from './InlineDictionary.js';
-export type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionInline | 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;
-}
-/**
- * Inline Dictionary Definition
- *
- * All words are defined inline.
- */
-interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, InlineDictionary {
-    /**
-     * Not used
-     * @hidden
-     */
-    path?: undefined;
-    /**
-     * Note used
-     * @deprecated true
-     * @deprecationMessage Use `path` instead.
-     * @hidden
-     */
-    file?: undefined;
-}
-export interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
-    words: string[];
-}
-export interface DictionaryDefinitionInlineFlagWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'flagWords'>> {
-    flagWords: string[];
-}
-export interface DictionaryDefinitionInlineIgnoreWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'ignoreWords'>> {
-    ignoreWords: string[];
-}
-/**
- * Inline Dictionary Definitions
- * @version 6.23.0
- */
-export type DictionaryDefinitionInline = DictionaryDefinitionInlineWords | DictionaryDefinitionInlineIgnoreWords | DictionaryDefinitionInlineFlagWords;
-/**
- * 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;
-export {};
-//# sourceMappingURL=DictionaryDefinition.d.ts.map

package/dist/esm/DictionaryDefinition.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/DictionaryDefinition.mjs

@@ -1 +0,0 @@
-export {};

package/dist/esm/DictionaryInformation.d.mts

@@ -1,210 +0,0 @@
-import type { SuggestionCostsDefs } from './suggestionCostsDef.mjs';
-/**
- * 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.mts.map