@cspell/cspell-types 7.1.1 → 7.2.0

package/dist/esm/DictionaryInformation.d.ts

@@ -1,210 +0,0 @@
-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/esm/DictionaryInformation.js

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

package/dist/esm/DictionaryInformation.mjs

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

package/dist/esm/InlineDictionary.d.mts

@@ -1,44 +0,0 @@
-export interface InlineDictionary {
-    /**
-     * List of words to be considered correct.
-     */
-    words?: string[];
-    /**
-     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
-     *
-     * Format of `flagWords`
-     * - single word entry - `word`
-     * - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
-     *
-     * Example:
-     * ```ts
-     * "flagWords": [
-     *   "color: colour",
-     *   "incase: in case, encase",
-     *   "canot->cannot",
-     *   "cancelled->canceled"
-     * ]
-     * ```
-     */
-    flagWords?: string[];
-    /**
-     * List of words to be ignored. An ignored word will not show up as an error, even if it is
-     * also in the `flagWords`.
-     */
-    ignoreWords?: string[];
-    /**
-     * A list of suggested replacements for words.
-     * Suggested words provide a way to make preferred suggestions on word replacements.
-     * To hint at a preferred change, but not to require it.
-     *
-     * Format of `suggestWords`
-     * - Single suggestion (possible auto fix)
-     *     - `word: suggestion`
-     *     - `word->suggestion`
-     * - Multiple suggestions (not auto fixable)
-     *    - `word: first, second, third`
-     *    - `word->first, second, third`
-     */
-    suggestWords?: string[];
-}
-//# sourceMappingURL=InlineDictionary.d.mts.map

package/dist/esm/InlineDictionary.d.ts

@@ -1,44 +0,0 @@
-export interface InlineDictionary {
-    /**
-     * List of words to be considered correct.
-     */
-    words?: string[];
-    /**
-     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
-     *
-     * Format of `flagWords`
-     * - single word entry - `word`
-     * - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
-     *
-     * Example:
-     * ```ts
-     * "flagWords": [
-     *   "color: colour",
-     *   "incase: in case, encase",
-     *   "canot->cannot",
-     *   "cancelled->canceled"
-     * ]
-     * ```
-     */
-    flagWords?: string[];
-    /**
-     * List of words to be ignored. An ignored word will not show up as an error, even if it is
-     * also in the `flagWords`.
-     */
-    ignoreWords?: string[];
-    /**
-     * A list of suggested replacements for words.
-     * Suggested words provide a way to make preferred suggestions on word replacements.
-     * To hint at a preferred change, but not to require it.
-     *
-     * Format of `suggestWords`
-     * - Single suggestion (possible auto fix)
-     *     - `word: suggestion`
-     *     - `word->suggestion`
-     * - Multiple suggestions (not auto fixable)
-     *    - `word: first, second, third`
-     *    - `word->first, second, third`
-     */
-    suggestWords?: string[];
-}
-//# sourceMappingURL=InlineDictionary.d.ts.map

package/dist/esm/InlineDictionary.js

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

package/dist/esm/InlineDictionary.mjs

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

package/dist/esm/Parser/index.d.mts

@@ -1,126 +0,0 @@
-export type ParserOptions = Record<string, unknown>;
-export type ParserName = string;
-export interface Parser {
-    /** Name of parser */
-    readonly name: ParserName;
-    /**
-     * Parse Method
-     * @param content - full content of the file
-     * @param filename - filename
-     */
-    parse(content: string, filename: string): ParseResult;
-}
-export interface ParseResult {
-    readonly content: string;
-    readonly filename: string;
-    readonly parsedTexts: Iterable<ParsedText>;
-}
-export interface ParsedText {
-    /**
-     * The text extracted and possibly transformed
-     */
-    readonly text: string;
-    /**
-     * The raw text before it has been transformed
-     */
-    readonly rawText?: string | undefined;
-    /**
-     * start and end offsets of the text
-     */
-    readonly range: Range;
-    /**
-     * The Scope annotation for a segment of text.
-     * Used by the spell checker to apply spell checking options
-     * based upon the value of the scope.
-     */
-    readonly scope?: Scope | undefined;
-    /**
-     * The source map is used to support text transformations.
-     *
-     * See: {@link SourceMap}
-     */
-    readonly map?: SourceMap | undefined;
-    /**
-     * Used to delegate parsing the contents of `text` to another parser.
-     *
-     */
-    readonly delegate?: DelegateInfo | undefined;
-}
-/**
- * A SourceMap is used to map transform a piece of text back to its original text.
- * This is necessary in order to report the correct location of a spelling issue.
- * An empty source map indicates that it was a 1:1 transformation.
- *
- * The values in a source map are number pairs (even, odd) relative to the beginning of each
- * string segment.
- * - even - offset in the source text
- * - odd - offset in the transformed text
- *
- * Offsets start a 0
- *
- * Example:
- *
- * - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
- * - Transformed text: `Grand Café Bjørvika`
- * - Map: [9, 9, 15, 10, 18, 13, 24, 14]
- *
- * | offset | original    | offset | transformed |
- * | ------ | ----------- | ------ | ----------- |
- * | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
- * | 9-15   | `\u00e9`    | 9-10   | `é`         |
- * | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
- * | 18-24  | `\u00f8`    | 13-14  | `ø`         |
- * | 24-29  | `rvika`     | 14-19  | `rvika`     |
- *
- * <!--- cspell:ignore Bjørvika rvika --->
- */
-export type SourceMap = number[];
-export type Range = readonly [start: number, end: number];
-/**
- * DelegateInfo is used by a parser to delegate parsing a subsection of a document to
- * another parser. The following information is used by the spell checker to match
- * the parser.
- */
-export interface DelegateInfo {
-    /**
-     * Proposed virtual file name including the extension.
-     * Format: `./${source_filename}/${block_number}.${ext}
-     * Example: `./README.md/1.js`
-     */
-    readonly filename: string;
-    /**
-     * The filename of the origin of the virtual file block.
-     * Example: `./README.md`
-     */
-    readonly originFilename: string;
-    /**
-     * Proposed file extension
-     * Example: `.js`
-     */
-    readonly extension: string;
-    /**
-     * Filetype to use
-     * Example: `javascript`
-     */
-    readonly fileType?: string;
-}
-/**
- * Scope - chain of scope going from local to global
- *
- * Example:
- * ```
- * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
- * ```
- */
-export interface ScopeChain {
-    readonly value: string;
-    readonly parent?: ScopeChain | undefined;
-}
-/**
- * A string representing a scope chain separated by spaces
- *
- * Example: `comment.block.documentation.ts meta.interface.ts source.ts`
- */
-export type ScopeString = string;
-export type Scope = ScopeChain | ScopeString;
-//# sourceMappingURL=index.d.mts.map

package/dist/esm/Parser/index.d.ts

@@ -1,126 +0,0 @@
-export type ParserOptions = Record<string, unknown>;
-export type ParserName = string;
-export interface Parser {
-    /** Name of parser */
-    readonly name: ParserName;
-    /**
-     * Parse Method
-     * @param content - full content of the file
-     * @param filename - filename
-     */
-    parse(content: string, filename: string): ParseResult;
-}
-export interface ParseResult {
-    readonly content: string;
-    readonly filename: string;
-    readonly parsedTexts: Iterable<ParsedText>;
-}
-export interface ParsedText {
-    /**
-     * The text extracted and possibly transformed
-     */
-    readonly text: string;
-    /**
-     * The raw text before it has been transformed
-     */
-    readonly rawText?: string | undefined;
-    /**
-     * start and end offsets of the text
-     */
-    readonly range: Range;
-    /**
-     * The Scope annotation for a segment of text.
-     * Used by the spell checker to apply spell checking options
-     * based upon the value of the scope.
-     */
-    readonly scope?: Scope | undefined;
-    /**
-     * The source map is used to support text transformations.
-     *
-     * See: {@link SourceMap}
-     */
-    readonly map?: SourceMap | undefined;
-    /**
-     * Used to delegate parsing the contents of `text` to another parser.
-     *
-     */
-    readonly delegate?: DelegateInfo | undefined;
-}
-/**
- * A SourceMap is used to map transform a piece of text back to its original text.
- * This is necessary in order to report the correct location of a spelling issue.
- * An empty source map indicates that it was a 1:1 transformation.
- *
- * The values in a source map are number pairs (even, odd) relative to the beginning of each
- * string segment.
- * - even - offset in the source text
- * - odd - offset in the transformed text
- *
- * Offsets start a 0
- *
- * Example:
- *
- * - Original text: `Grand Caf\u00e9 Bj\u00f8rvika`
- * - Transformed text: `Grand Café Bjørvika`
- * - Map: [9, 9, 15, 10, 18, 13, 24, 14]
- *
- * | offset | original    | offset | transformed |
- * | ------ | ----------- | ------ | ----------- |
- * | 0-9    | `Grand Caf` | 0-9    | `Grand Caf` |
- * | 9-15   | `\u00e9`    | 9-10   | `é`         |
- * | 15-18  | ` Bj`       | 10-13  | ` Bj`       |
- * | 18-24  | `\u00f8`    | 13-14  | `ø`         |
- * | 24-29  | `rvika`     | 14-19  | `rvika`     |
- *
- * <!--- cspell:ignore Bjørvika rvika --->
- */
-export type SourceMap = number[];
-export type Range = readonly [start: number, end: number];
-/**
- * DelegateInfo is used by a parser to delegate parsing a subsection of a document to
- * another parser. The following information is used by the spell checker to match
- * the parser.
- */
-export interface DelegateInfo {
-    /**
-     * Proposed virtual file name including the extension.
-     * Format: `./${source_filename}/${block_number}.${ext}
-     * Example: `./README.md/1.js`
-     */
-    readonly filename: string;
-    /**
-     * The filename of the origin of the virtual file block.
-     * Example: `./README.md`
-     */
-    readonly originFilename: string;
-    /**
-     * Proposed file extension
-     * Example: `.js`
-     */
-    readonly extension: string;
-    /**
-     * Filetype to use
-     * Example: `javascript`
-     */
-    readonly fileType?: string;
-}
-/**
- * Scope - chain of scope going from local to global
- *
- * Example:
- * ```
- * `comment.block.documentation.ts` -> `meta.interface.ts` -> `source.ts`
- * ```
- */
-export interface ScopeChain {
-    readonly value: string;
-    readonly parent?: ScopeChain | undefined;
-}
-/**
- * A string representing a scope chain separated by spaces
- *
- * Example: `comment.block.documentation.ts meta.interface.ts source.ts`
- */
-export type ScopeString = string;
-export type Scope = ScopeChain | ScopeString;
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/Parser/index.js

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

package/dist/esm/Parser/index.mjs

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

package/dist/esm/TextMap.d.mts

@@ -1,36 +0,0 @@
-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.mts.map

package/dist/esm/TextMap.d.ts

@@ -1,36 +0,0 @@
-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/esm/TextMap.js

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

package/dist/esm/TextMap.mjs

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

package/dist/esm/TextOffset.d.mts

@@ -1,23 +0,0 @@
-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.mts.map

package/dist/esm/TextOffset.d.ts

@@ -1,23 +0,0 @@
-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/esm/TextOffset.js

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