@cspell/cspell-types 5.15.0 → 5.16.0

package/cspell.schema.json

@@ -7,7 +7,7 @@
       "properties": {
         "cacheLocation": {
           "$ref": "#/definitions/FSPathResolvable",
-          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which"
+          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
         },
         "cacheStrategy": {
           "$ref": "#/definitions/CacheStrategy",
@@ -30,6 +30,108 @@
       ],
       "type": "string"
     },
+    "CostMapDefInsDel": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "A description to describe the purpose of the map.",
+          "type": "string"
+        },
+        "insDel": {
+          "description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
+          "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`.\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"
+        },
+        "swap": {
+          "description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
+          "type": "number"
+        }
+      },
+      "required": [
+        "insDel",
+        "map"
+      ],
+      "type": "object"
+    },
+    "CostMapDefReplace": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "A description to describe the purpose of the map.",
+          "type": "string"
+        },
+        "insDel": {
+          "description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
+          "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`.\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"
+        },
+        "swap": {
+          "description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
+          "type": "number"
+        }
+      },
+      "required": [
+        "map",
+        "replace"
+      ],
+      "type": "object"
+    },
+    "CostMapDefSwap": {
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "description": "A description to describe the purpose of the map.",
+          "type": "string"
+        },
+        "insDel": {
+          "description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
+          "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`.\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"
+        },
+        "swap": {
+          "description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
+          "type": "number"
+        }
+      },
+      "required": [
+        "map",
+        "swap"
+      ],
+      "type": "object"
+    },
     "CustomDictionaryPath": {
       "description": "A File System Path to a dictionary file.",
       "pattern": "^.*\\.txt$",
@@ -85,6 +187,10 @@
           "$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",
@@ -143,6 +249,10 @@
           ],
           "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",
@@ -183,6 +293,10 @@
           "$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",
@@ -242,6 +356,20 @@
       "$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."
     },
+    "FeatureEnableOnly": {
+      "type": "boolean"
+    },
+    "Features": {
+      "additionalProperties": false,
+      "description": "Features are behaviors or settings that can be explicitly configured.",
+      "properties": {
+        "weighted-suggestions": {
+          "$ref": "#/definitions/FeatureEnableOnly",
+          "description": "Enable/disable using weighted suggestions."
+        }
+      },
+      "type": "object"
+    },
     "FsPath": {
       "description": "A File System Path. Relative paths are relative to the configuration file.",
       "type": "string"
@@ -742,6 +870,26 @@
       "description": "Simple Glob string, the root will be globRoot.",
       "type": "string"
     },
+    "SuggestionCostMapDef": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CostMapDefReplace"
+        },
+        {
+          "$ref": "#/definitions/CostMapDefInsDel"
+        },
+        {
+          "$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```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": {
+        "$ref": "#/definitions/SuggestionCostMapDef"
+      },
+      "type": "array"
+    },
     "Version": {
       "anyOf": [
         {
@@ -828,6 +976,10 @@
       },
       "type": "array"
     },
+    "features": {
+      "$ref": "#/definitions/Features",
+      "description": "Configure CSpell features.\n\n- Added with `v5.16.0`."
+    },
     "files": {
       "description": "Glob patterns of files to be checked. Glob patterns are relative to the `globRoot` of the configuration file that defines them.",
       "items": {

package/dist/CSpellReporter.d.ts

@@ -45,7 +45,7 @@ export interface RunResult {
     /** Number of processing errors. */
     errors: number;
     /** Number files that used results from the cache. */
-    cachedFiles: number;
+    cachedFiles?: number;
 }
 export declare type ResultEmitter = (result: RunResult) => void | Promise<void>;
 export interface CSpellReporter {

package/dist/CSpellSettingsDef.d.ts

@@ -1,3 +1,5 @@
+import { Features } from './features';
+import type { SuggestionCostsDefs } from './suggestionCostsDef';
 export declare type ReplaceEntry = [string, string];
 export declare type ReplaceMap = ReplaceEntry[];
 /**
@@ -86,6 +88,12 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      * Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.
      */
     gitignoreRoot?: FsPath | FsPath[];
+    /**
+     * Configure CSpell features.
+     *
+     * - Added with `v5.16.0`.
+     */
+    features?: Features;
 }
 export interface ExtendableSettings extends Settings {
     /** Overrides to apply based upon the file path. */
@@ -199,7 +207,10 @@ export interface CacheSettings {
     /**
      * Path to the cache location. Can be a file or a directory.
      * If none specified `.cspellcache` will be used.
-     * Relative paths are relative to the config file in which
+     * Relative paths are relative to the config file in which it
+     * is defined.
+     *
+     * A prefix of `${cwd}` is replaced with the current working directory.
      */
     cacheLocation?: FSPathResolvable;
     /**
@@ -374,6 +385,13 @@ 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. */

package/dist/configFields.js

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

package/dist/features.d.ts

@@ -0,0 +1,38 @@
+/**
+ * These are experimental features and are subject to change or removal.
+ */
+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 declare type Feature = FeatureEnableOnly | FeatureWithConfiguration;
+export declare type FeatureEnableOnly = boolean;
+/**
+ * Feature Configuration.
+ */
+export interface FeatureWithConfiguration {
+    enable: boolean;
+}
+export declare type FeatureNamesKnown = keyof Features;
+export declare type FeatureNamesExperimental = keyof FeaturesExperimental;
+export declare type FeatureNamesActive = keyof FeaturesActive;
+export declare type FeatureNamesDeprecated = keyof FeaturesDeprecated;
+//# sourceMappingURL=features.d.ts.map

package/dist/features.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-empty-interface */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=features.js.map

package/dist/index.d.ts

@@ -1,5 +1,8 @@
-export { ConfigFields, type CSpellUserSettingsFields } from './configFields';
+export { ConfigFields } from './configFields';
+export type { CSpellUserSettingsFields } from './configFields';
 export * from './CSpellReporter';
 export * from './CSpellSettingsDef';
+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/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigFields = void 0;
+// Using old-style of `type` exports because the new style breaks some integrations.
 var configFields_1 = require("./configFields");
 Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_1.ConfigFields; } });
 __exportStar(require("./CSpellReporter"), exports);

package/dist/suggestionCostsDef.d.ts

@@ -0,0 +1,88 @@
+/**
+ * A WeightedMapDef enables setting weights for edits between related characters and substrings.
+ *
+ * Multiple groups can be defined using a `|`.
+ * A multi-character substring is defined using `()`.
+ *
+ * For example, in some languages, some letters sound alike.
+ *
+ * ```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.
+ * ```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.
+ */
+export declare type SuggestionCostMapDef = CostMapDefReplace | CostMapDefInsDel | CostMapDefSwap;
+export declare type SuggestionCostsDefs = SuggestionCostMapDef[];
+interface CostMapDefBase {
+    /**
+     * The set of substrings to map, these are generally single character strings.
+     *
+     * Multiple sets can be defined by using a `|` to separate them.
+     *
+     * Example: `"eéê|aåá"` contains two different sets.
+     *
+     * 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. */
+    insDel?: number;
+    /**
+     * 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.
+     */
+    replace?: number;
+    /**
+     * The cost to swap two adjacent substrings found in the map.
+     * Example: Map['e', 'i']
+     * This represents the cost to change `ei` to `ie` or the reverse.
+     */
+    swap?: number;
+    /**
+     * 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;
+}
+export interface CostMapDefInsDel extends CostMapDefBase {
+    insDel: number;
+}
+export interface CostMapDefSwap extends CostMapDefBase {
+    swap: number;
+}
+export {};
+//# sourceMappingURL=suggestionCostsDef.d.ts.map

package/dist/suggestionCostsDef.js

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

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.15.0",
+  "version": "5.16.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,6 +19,7 @@
     "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",
+    "test-build-docs": "typedoc --out ./temp/docs src/index.ts",
     "clean-build": "npm run clean && npm run build",
     "compile": "tsc -p .",
     "test-schema": "ajv -s ./cspell.schema.json -d \"cspell.test.{json,yaml}\" -c ./ajv.config.js",
@@ -49,12 +50,12 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^27.4.6",
+    "jest": "^27.4.7",
     "rimraf": "^3.0.2",
     "ts-json-schema-generator": "^0.97.0",
-    "typedoc": "^0.22.10",
-    "typedoc-plugin-markdown": "^3.11.9",
+    "typedoc": "0.22.11",
+    "typedoc-plugin-markdown": "^3.11.12",
     "typescript": "^4.5.4"
   },
-  "gitHead": "04d61378054cbecd28df100ca704c7322abab8ba"
+  "gitHead": "c5d994f58bdb48c4d16f1708607b28c8a7b52a65"
 }