@cspell/cspell-types 5.15.3 → 5.18.0-alpha.0

package/cspell.schema.json

@@ -30,6 +30,32 @@
       ],
       "type": "string"
     },
+    "CharacterSet": {
+      "description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side    are not related.",
+      "type": "string"
+    },
+    "CharacterSetCosts": {
+      "additionalProperties": false,
+      "properties": {
+        "characters": {
+          "$ref": "#/definitions/CharacterSet",
+          "description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side    are not related."
+        },
+        "cost": {
+          "description": "the cost to insert / delete / replace / swap the characters in a group",
+          "type": "number"
+        },
+        "penalty": {
+          "description": "The penalty cost to apply if the accent is used. This is used to discourage",
+          "type": "number"
+        }
+      },
+      "required": [
+        "characters",
+        "cost"
+      ],
+      "type": "object"
+    },
     "CostMapDefInsDel": {
       "additionalProperties": false,
       "properties": {
@@ -42,9 +68,13 @@
           "type": "number"
         },
         "map": {
-          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.",
+          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
           "type": "string"
         },
+        "penalty": {
+          "description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
+          "type": "number"
+        },
         "replace": {
           "description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
           "type": "number"
@@ -72,9 +102,13 @@
           "type": "number"
         },
         "map": {
-          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.",
+          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
           "type": "string"
         },
+        "penalty": {
+          "description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
+          "type": "number"
+        },
         "replace": {
           "description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
           "type": "number"
@@ -102,9 +136,13 @@
           "type": "number"
         },
         "map": {
-          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.",
+          "description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
           "type": "string"
         },
+        "penalty": {
+          "description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
+          "type": "number"
+        },
         "replace": {
           "description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
           "type": "number"
@@ -142,6 +180,9 @@
         {
           "$ref": "#/definitions/DictionaryDefinitionCustom"
         },
+        {
+          "$ref": "#/definitions/DictionaryDefinitionAugmented"
+        },
         {
           "$ref": "#/definitions/DictionaryDefinitionAlternate"
         }
@@ -175,10 +216,6 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -195,6 +232,49 @@
       ],
       "type": "object"
     },
+    "DictionaryDefinitionAugmented": {
+      "additionalProperties": false,
+      "description": "Used to provide extra data related to the dictionary",
+      "properties": {
+        "description": {
+          "description": "Optional description.",
+          "type": "string"
+        },
+        "dictionaryInformation": {
+          "$ref": "#/definitions/DictionaryInformation"
+        },
+        "name": {
+          "$ref": "#/definitions/DictionaryId",
+          "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
+        },
+        "noSuggest": {
+          "description": "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.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
+          "type": "boolean"
+        },
+        "path": {
+          "$ref": "#/definitions/DictionaryPath",
+          "description": "Path to the file."
+        },
+        "repMap": {
+          "$ref": "#/definitions/ReplaceMap",
+          "description": "Replacement pairs."
+        },
+        "type": {
+          "$ref": "#/definitions/DictionaryFileTypes",
+          "default": "S",
+          "description": "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."
+        },
+        "useCompounds": {
+          "description": "Use Compounds.",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "name",
+        "path"
+      ],
+      "type": "object"
+    },
     "DictionaryDefinitionCustom": {
       "additionalProperties": false,
       "description": "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.",
@@ -237,10 +317,6 @@
           ],
           "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -281,10 +357,6 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
-        "suggestionEditCosts": {
-          "$ref": "#/definitions/SuggestionCostsDefs",
-          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.\n\nAdded with `v5.16.0`."
-        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -315,6 +387,59 @@
       "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
       "type": "string"
     },
+    "DictionaryInformation": {
+      "additionalProperties": false,
+      "description": "Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\n\nAdded with `v5.16.0`.",
+      "properties": {
+        "accents": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CharacterSet"
+            },
+            {
+              "items": {
+                "$ref": "#/definitions/CharacterSetCosts"
+              },
+              "type": "array"
+            }
+          ],
+          "default": "̀-́",
+          "description": "The accent characters"
+        },
+        "alphabet": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CharacterSet"
+            },
+            {
+              "items": {
+                "$ref": "#/definitions/CharacterSetCosts"
+              },
+              "type": "array"
+            }
+          ],
+          "default": "a-zA-Z",
+          "description": "The alphabet to use."
+        },
+        "costs": {
+          "$ref": "#/definitions/EditCosts",
+          "description": "Define edit costs."
+        },
+        "hunspellInformation": {
+          "$ref": "#/definitions/HunspellInformation",
+          "description": "Used by dictionary authors"
+        },
+        "locale": {
+          "description": "The locale of the dictionary. Example: `nl,nl-be`",
+          "type": "string"
+        },
+        "suggestionEditCosts": {
+          "$ref": "#/definitions/SuggestionCostsDefs",
+          "description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list."
+        }
+      },
+      "type": "object"
+    },
     "DictionaryNegRef": {
       "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.",
       "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
@@ -340,6 +465,37 @@
       ],
       "description": "Reference to a dictionary by name. One of:\n-  {@link  DictionaryRef } \n-  {@link  DictionaryNegRef }"
     },
+    "EditCosts": {
+      "additionalProperties": false,
+      "properties": {
+        "accentCosts": {
+          "default": 1,
+          "description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
+          "type": "number"
+        },
+        "baseCost": {
+          "default": 100,
+          "description": "This is the base cost for making an edit.",
+          "type": "number"
+        },
+        "capsCosts": {
+          "default": 1,
+          "description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
+          "type": "number"
+        },
+        "firstLetterPenalty": {
+          "default": 4,
+          "description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
+          "type": "number"
+        },
+        "nonAlphabetCosts": {
+          "default": 110,
+          "description": "This is the cost for characters not in the alphabet.",
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "FSPathResolvable": {
       "$ref": "#/definitions/FsPath",
       "description": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."
@@ -366,6 +522,75 @@
       "$ref": "#/definitions/SimpleGlob",
       "description": "These are glob expressions."
     },
+    "HunspellInformation": {
+      "additionalProperties": false,
+      "properties": {
+        "aff": {
+          "description": "Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(IJ) ```",
+          "type": "string"
+        },
+        "costs": {
+          "additionalProperties": false,
+          "description": "The costs to apply when using the hunspell settings",
+          "properties": {
+            "accentCosts": {
+              "default": 1,
+              "description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
+              "type": "number"
+            },
+            "baseCost": {
+              "default": 100,
+              "description": "This is the base cost for making an edit.",
+              "type": "number"
+            },
+            "capsCosts": {
+              "default": 1,
+              "description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
+              "type": "number"
+            },
+            "firstLetterPenalty": {
+              "default": 4,
+              "description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
+              "type": "number"
+            },
+            "ioConvertCost": {
+              "default": 30,
+              "description": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
+              "type": "number"
+            },
+            "keyboardCost": {
+              "default": 99,
+              "description": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
+              "type": "number"
+            },
+            "mapCost": {
+              "default": 25,
+              "description": "mapSet replacement cost is the cost to substitute one character with another from the same set.\n\nMap characters are considered very similar to each other and are often the cause of simple mistakes.",
+              "type": "number"
+            },
+            "nonAlphabetCosts": {
+              "default": 110,
+              "description": "This is the cost for characters not in the alphabet.",
+              "type": "number"
+            },
+            "replaceCosts": {
+              "default": 75,
+              "description": "The cost to substitute pairs found in the replace settings.",
+              "type": "number"
+            },
+            "tryCharCost": {
+              "description": "The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`",
+              "type": "number"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "aff"
+      ],
+      "type": "object"
+    },
     "LanguageId": {
       "anyOf": [
         {
@@ -870,7 +1095,7 @@
           "$ref": "#/definitions/CostMapDefSwap"
         }
       ],
-      "description": "A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```ts {   map: 'sc(sh)(sch)(ss)|t(tt)', // two groups.   replace: 50, // Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. } ```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```ts {   map: 'aeiouy', //.   insDel: 50, // Make it is cheaper to insert or delete a vowel.   replace: 45, // It is even cheaper to replace one with another. } ```\n\nNote: the default edit distance is 100."
+      "description": "A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml   map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.   replace: 50    # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml   map: 'aeiouy'   insDel: 50     # Make it is cheaper to insert or delete a vowel.   replace: 45    # It is even cheaper to replace one with another. ```\n\nNote: the default edit distance is 100."
     },
     "SuggestionCostsDefs": {
       "items": {
@@ -964,6 +1189,11 @@
       },
       "type": "array"
     },
+    "failFast": {
+      "default": false,
+      "description": "Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)",
+      "type": "boolean"
+    },
     "features": {
       "$ref": "#/definitions/Features",
       "description": "Configure CSpell features.\n\n- Added with `v5.16.0`."

package/dist/CSpellSettingsDef.d.ts

@@ -1,5 +1,5 @@
-import { Features } from './features';
-import type { SuggestionCostsDefs } from './suggestionCostsDef';
+import type { DictionaryInformation } from './DictionaryInformation';
+import type { Features } from './features';
 export declare type ReplaceEntry = [string, string];
 export declare type ReplaceMap = ReplaceEntry[];
 /**
@@ -227,6 +227,11 @@ export interface CommandLineSettings {
      * Define cache settings.
      */
     cache?: CacheSettings;
+    /**
+     * Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)
+     * @default false
+     */
+    failFast?: boolean;
 }
 /**
  * To prevent the unwanted execution of untrusted code, WorkspaceTrustSettings
@@ -346,7 +351,7 @@ export interface BaseSetting {
     patterns?: RegExpPatternDefinition[];
 }
 export declare type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
-export declare type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
+export declare type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAugmented | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
 export interface DictionaryDefinitionBase {
     /**
      * This is the name of a dictionary.
@@ -385,13 +390,6 @@ export interface DictionaryDefinitionBase {
      * @default "S"
      */
     type?: DictionaryFileTypes;
-    /**
-     * Used in making suggestions. The lower the value, the more likely the suggestion
-     * will be near the top of the suggestion list.
-     *
-     * Added with `v5.16.0`.
-     */
-    suggestionEditCosts?: SuggestionCostsDefs;
 }
 export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
     /** Path to the file. */
@@ -404,6 +402,12 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
      */
     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
@@ -418,6 +422,8 @@ export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase
      * @deprecationMessage Use `path` instead.
      */
     file: DictionaryPath;
+    /** @hidden */
+    suggestionEditCosts?: undefined;
 }
 /**
  * @deprecated true
@@ -442,6 +448,10 @@ export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
      * @default "S"
      */
     type?: DictionaryFileTypes;
+    /**
+     * @hidden
+     */
+    suggestionEditCosts?: undefined;
 }
 /**
  * Specifies the scope of a dictionary.

package/dist/DictionaryInformation.d.ts

@@ -0,0 +1,286 @@
+import { SuggestionCostsDefs } from './suggestionCostsDef';
+/**
+ * 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;
+}
+export interface HunspellInformationParsed {
+    /**
+     * This is generally the alphabet used in the dictionary.
+     * It stands for the characters to try using for substitutions
+     * when looking for a suggestions.
+     *
+     * Example:
+     * - Hunspell:
+     *   ```hunspell
+     *   TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
+     *   ```
+     * - Use: yaml
+     *   ```yaml
+     *   tryChars: "aeistlunkodmrvpgjhäõbüoöfcwzxðqþ"
+     *   ```
+     * <!--- cspell:ignore aeistlunkodmrvpgjhäõbüoöfcwzxðqþ  --
+     */
+    tryChars?: string;
+    /**
+     * This defines characters that are good substitutes for each other.
+     * - A `()` is need for multi character sequences like letters with multiple accents.
+     * - Separate unrelated characters with `|` or `\n`
+     *
+     * Example:
+     * - Hunspell:
+     *   ```hunspell
+     *   MAP aàâäAÀÂÄ
+     *   MAP eéèêëEÉÈÊË
+     *   MAP iîïyIÎÏY
+     *   MAP oôöOÔÖ
+     *   MAP (IJ)(IJ)
+     *   ```
+     * - Use:
+     *   `yaml`
+     *   ```yaml
+     *   mapSets: |
+     *     aàâäAÀÂÄ|eéèêëEÉÈÊË`
+     *     eéèêëEÉÈÊË|iîïyIÎÏY
+     *     oôöOÔÖ|(IJ)(IJ)
+     *   ```
+     * <!--- cspell:ignore aàâä eéèêë iîïy -->
+     */
+    mapSets?: string | string[];
+    /**
+     * This represents the layout of a common keyboard.
+     * Used for adjacency mistakes.
+     *
+     * Hunspell:
+     * ```hunspell
+     * KEY qwertyuiop|asdfghjkl|zxcvbnm
+     * ```
+     * Use:
+     * ```yaml
+     * keyboard: qwertyuiop|asdfghjkl|zxcvbnm
+     * ```
+     * <!--- cspell:ignore asdfghjkl qwertyuiop zxcvbnm -->
+     */
+    keyboard?: string;
+    /**
+     * Output Conversions
+     *
+     */
+    outConvert?: string | string[];
+    inConvert?: string | string[];
+    /**
+     * Common Substitutions.
+     * Special characters:
+     * - `^` - matches the beginning of a word.
+     * - `$` - matches the end of a word.
+     *
+     * Hunspell:
+     * ```hunspell
+     * REP c ss
+     * REP e ij
+     * REP é ee
+     * REP g ch
+     * REP ï ii
+     * REP t d	# gebiest=>gebiesd
+     * REP u ij
+     * ```
+     *
+     * Use:
+     * ```yaml
+     * replace: |
+     *   c ss
+     *   e ij
+     *   é ee
+     *   g ch
+     *   ï ii
+     *   t d
+     *   u ij
+     * ```
+     *
+     * <!--- cspell:ignore gebiesd gebiest -->
+     */
+    replace?: string | string[];
+    /** The costs to apply when using the hunspell settings */
+    costs?: HunspellCosts;
+}
+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)
+ * ```
+ */
+declare 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 declare 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 {};
+//# sourceMappingURL=DictionaryInformation.d.ts.map

package/dist/DictionaryInformation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DictionaryInformation.js.map

package/dist/configFields.js

@@ -12,6 +12,7 @@ exports.ConfigFields = {
     enabledLanguageIds: 'enabledLanguageIds',
     enableFiletypes: 'enableFiletypes',
     enableGlobDot: 'enableGlobDot',
+    failFast: 'failFast',
     features: 'features',
     files: 'files',
     flagWords: 'flagWords',

package/dist/features.d.ts

@@ -1,5 +1,5 @@
 /**
- * These are experimental features and are subject to change or removal.
+ * These are experimental features and are subject to change or removal without notice.
  */
 export interface FeaturesExperimental {
     /**

package/dist/index.d.ts

@@ -2,7 +2,8 @@ export { ConfigFields } from './configFields';
 export type { CSpellUserSettingsFields } from './configFields';
 export * from './CSpellReporter';
 export * from './CSpellSettingsDef';
+export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation';
+export type { Feature, Features } from './features';
 export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef';
 export type { TextDocumentOffset, TextOffset } from './TextOffset';
-export type { Features, Feature } from './features';
 //# sourceMappingURL=index.d.ts.map

package/dist/suggestionCostsDef.d.ts

@@ -6,20 +6,16 @@
  *
  * For example, in some languages, some letters sound alike.
  *
- * ```ts
- * {
- *   map: 'sc(sh)(sch)(ss)|t(tt)', // two groups.
- *   replace: 50, // Make it 1/2 the cost of a normal edit to replace a `t` with `tt`.
- * }
+ * ```yaml
+ *   map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.
+ *   replace: 50    # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`.
  * ```
  *
  * The following could be used to make inserting, removing, or replacing vowels cheaper.
- * ```ts
- * {
- *   map: 'aeiouy', //.
- *   insDel: 50, // Make it is cheaper to insert or delete a vowel.
- *   replace: 45, // It is even cheaper to replace one with another.
- * }
+ * ```yaml
+ *   map: 'aeiouy'
+ *   insDel: 50     # Make it is cheaper to insert or delete a vowel.
+ *   replace: 45    # It is even cheaper to replace one with another.
  * ```
  *
  * Note: the default edit distance is 100.
@@ -37,6 +33,10 @@ interface CostMapDefBase {
      * To add a multi-character substring use `()`.
      *
      * Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.
+     *
+     * - To match the beginning of a word, use `^`: `"(^I)""`.
+     * - To match the end of a word, use `$`: `"(e$)(ing$)"`.
+     *
      */
     map: string;
     /** The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. */
@@ -57,6 +57,23 @@ interface CostMapDefBase {
      * A description to describe the purpose of the map.
      */
     description?: string;
+    /**
+     * Add a penalty to the final cost.
+     * This is used to discourage certain suggestions.
+     *
+     * Example:
+     * ```yaml
+     * # Match adding/removing `-` to the end of a word.
+     * map: "$(-$)"
+     * replace: 50
+     * penalty: 100
+     * ```
+     *
+     * This makes adding a `-` to the end of a word more expensive.
+     *
+     * Think of it as taking the toll way for speed but getting the bill later.
+     */
+    penalty?: number;
 }
 export interface CostMapDefReplace extends CostMapDefBase {
     replace: number;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.15.3",
+  "version": "5.18.0-alpha.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "build": "npm run compile && npm run build-schema",
     "build-dev": "tsc -p tsconfig.dev.json",
     "build-schema": "ts-json-schema-generator --no-top-ref --path src/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && cp ./cspell.schema.json ../..",
-    "build-docs": "typedoc --out ../../docs/types/cspell-types src/index.ts",
+    "build-docs": "rimraf ../../docs/types/cspell-types && typedoc --out ../../docs/types/cspell-types src/index.ts",
     "test-build-docs": "typedoc --out ./temp/docs src/index.ts",
     "clean-build": "npm run clean && npm run build",
     "compile": "tsc -p .",
@@ -55,7 +55,7 @@
     "ts-json-schema-generator": "^0.97.0",
     "typedoc": "0.22.11",
     "typedoc-plugin-markdown": "^3.11.12",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
-  "gitHead": "8a7c55b7d0b340d3c4e964ba91390a405f2cda2d"
+  "gitHead": "d3c6f34444f19e9d8e375d1cbea6f99d0f270716"
 }