@cspell/cspell-types 5.17.0 → 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": {
@@ -365,10 +391,48 @@
       "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."
@@ -401,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."
@@ -438,9 +533,24 @@
           "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 - tryCharCost`.",
+              "description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
               "type": "number"
             },
             "ioConvertCost": {
@@ -449,7 +559,7 @@
               "type": "number"
             },
             "keyboardCost": {
-              "default": 94,
+              "default": 99,
               "description": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
               "type": "number"
             },
@@ -458,14 +568,18 @@
               "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": {
-              "default": 95,
-              "description": "The cost of inserting / deleting / or swapping any `tryChars`",
+              "description": "The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`",
               "type": "number"
             }
           },

package/dist/DictionaryInformation.d.ts

@@ -1,4 +1,4 @@
-import { SuggestionCostsDefs } from '.';
+import { SuggestionCostsDefs } from './suggestionCostsDef';
 /**
  * Use by dictionary authors to help improve the quality of suggestions
  * given from the dictionary.
@@ -6,6 +6,25 @@ import { SuggestionCostsDefs } from '.';
  * 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.
@@ -169,23 +188,17 @@ export interface HunspellInformation {
  * ```
  */
 declare type HunspellAffContent = string;
-interface HunspellCosts {
+interface HunspellCosts extends EditCosts {
     /**
      * The cost of inserting / deleting / or swapping any `tryChars`
-     * @default 95
+     * Defaults to `baseCosts`
      */
     tryCharCost?: number;
-    /**
-     * The extra cost incurred for changing the first letter of a word.
-     * This value should be less than `100 - tryCharCost`.
-     * @default 4
-     */
-    firstLetterPenalty?: number;
     /**
      * The cost of replacing or swapping any adjacent keyboard characters.
      *
      * This should be slightly cheaper than `tryCharCost`.
-     * @default 94
+     * @default 99
      */
     keyboardCost?: number;
     /**
@@ -213,5 +226,61 @@ interface HunspellCosts {
      */
     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/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/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.17.0",
+  "version": "5.18.0-alpha.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -57,5 +57,5 @@
     "typedoc-plugin-markdown": "^3.11.12",
     "typescript": "^4.5.5"
   },
-  "gitHead": "4e02d88a7add382088eb16d9b200e4bf07434f8f"
+  "gitHead": "d3c6f34444f19e9d8e375d1cbea6f99d0f270716"
 }