@cspell/cspell-types 6.19.2 → 6.20.1

package/dist/esm/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 type SuggestionCostMapDef = CostMapDefReplace | CostMapDefInsDel | CostMapDefSwap;
+export 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/esm/suggestionCostsDef.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=suggestionCostsDef.js.map

package/dist/esm/types.d.ts

@@ -0,0 +1,9 @@
+export type Serialize<T> = T extends Function ? never : T extends null ? null : T extends any[] ? SerializeArray<T> : T extends object ? SerializeObj<T> : Primitives<T>;
+type SerializeObj<T extends object> = {
+    [K in keyof T]: K extends string | number ? Serialize<T[K]> : never;
+};
+type SerializeArray<T extends Array<any>> = T extends [infer R] ? [Serialize<R>] : T extends [infer R0, infer R1] ? [Serialize<R0>, Serialize<R1>] : T extends [infer R0, infer R1, infer R2] ? [Serialize<R0>, Serialize<R1>, Serialize<R2>] : T extends Array<infer R> ? Serialize<R>[] : never;
+type Primitives<T> = Extract<T, number | string | null | boolean>;
+export type Serializable = number | string | boolean | null | object;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.js

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/ban-types */
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -3,41 +3,66 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.19.2",
+  "version": "6.20.1",
   "description": "Types for cspell and cspell-lib",
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "types": "./dist/esm/index.d.ts",
+      "require": "./dist/cjs/index.cjs"
+    },
+    "./Parser": {
+      "import": "./dist/esm/Parser/index.js",
+      "types": "./dist/esm/Parser/index.d.ts",
+      "require": "./dist/cjs/Parser/index.cjs"
+    },
+    "./cspell.schema.json": {
+      "import": "./cspell.schema.json",
+      "require": "./cspell.schema.json"
+    },
+    "./ajv.config": {
+      "import": "./ajv.config.cjs",
+      "require": "./ajv.config.cjs"
+    },
+    "./ajv.config.js": {
+      "require": "./ajv.config.cjs"
+    }
+  },
+  "types": "index.d.ts",
   "typesVersions": {
     "*": {
-      "*": [
-        "dist/*"
+      "index.d.ts": [
+        "dist/esm/index.d.ts"
       ],
-      "dist/index.d.ts": [
-        "dist/index.d.ts"
+      "dist/esm/index.d.ts": [
+        "dist/esm/index.d.ts"
       ],
-      "index.d.ts": [
-        "dist/index.d.ts"
+      "Parser": [
+        "dist/esm/Parser/index.d.ts"
+      ],
+      "*": [
+        "dist/esm/*.d.ts",
+        "dist/esm/*/index.d.ts"
       ]
     }
   },
-  "exports": {
-    ".": "./dist/index.js",
-    "./Parser": "./dist/Parser.js",
-    "./Parser.js": "./dist/Parser.js",
-    "./cspell.schema.json": "./cspell.schema.json",
-    "./ajv.config": "./ajv.config.js",
-    "./ajv.config.js": "./ajv.config.js"
-  },
   "scripts": {
     "clean": "shx rm -rf dist coverage .tsbuildinfo",
-    "build": "pnpm run compile && pnpm run build-schema",
-    "build-dev": "tsc -p tsconfig.dev.json",
+    "build": "pnpm build:cjs && pnpm build:esm && pnpm run build-schema",
+    "build:cjs": "rollup -c rollup.config.mjs",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "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 && shx cp ./cspell.schema.json ../..",
     "clean-build": "pnpm run clean && pnpm run build",
-    "compile": "tsc -p .",
-    "test-schema": "ajv -s ./cspell.schema.json -d \"cspell.test.{json,yaml}\" -c ./ajv.config.js",
-    "test": "jest && pnpm run test-schema",
+    "coverage": "pnpm coverage:vitest && pnpm coverage:fix",
+    "coverage:vitest": "vitest run --coverage",
+    "coverage:fix": "nyc report --temp-dir \"$(pwd)/coverage\" --reporter lcov --report-dir \"$(pwd)/coverage\" --cwd ../..",
+    "test": "pnpm test:unit && pnpm test:schema",
+    "test:unit": "vitest run",
+    "test:schema": "ajv -s ./cspell.schema.json -d \"cspell.test.{json,yaml}\" -c ./ajv.config.cjs",
     "prepare": "echo Skip Building Types"
   },
   "repository": {
@@ -46,7 +71,7 @@
   },
   "files": [
     "dist",
-    "ajv.config.js",
+    "ajv.config.cjs",
     "cspell.schema.json",
     "!**/__mocks__",
     "!**/*.test.*",
@@ -64,9 +89,10 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^29.3.1",
+    "jest": "^29.4.1",
     "ts-json-schema-generator": "^1.2.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5",
+    "vitest": "^0.28.3"
   },
-  "gitHead": "0413716934fdfde59971d24773e7df83623bb529"
+  "gitHead": "508a06d32dd59d881d07cb60fe8c0a7c0bddf8eb"
 }

package/dist/CSpellReporter.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageTypes = exports.IssueType = void 0;
-var IssueType;
-(function (IssueType) {
-    IssueType[IssueType["spelling"] = 0] = "spelling";
-    IssueType[IssueType["directive"] = 1] = "directive";
-})(IssueType = exports.IssueType || (exports.IssueType = {}));
-exports.MessageTypes = {
-    Debug: 'Debug',
-    Info: 'Info',
-    Warning: 'Warning',
-};
-//# sourceMappingURL=CSpellReporter.js.map

package/dist/CSpellSettingsDef.js

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

package/dist/DictionaryDefinition.js

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

package/dist/DictionaryInformation.js

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

package/dist/Parser.js

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

package/dist/TextMap.js

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

package/dist/TextOffset.js

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

package/dist/features.js

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

package/dist/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageTypes = exports.IssueType = exports.ConfigFields = void 0;
-var configFields_1 = require("./configFields");
-Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_1.ConfigFields; } });
-var CSpellReporter_1 = require("./CSpellReporter");
-Object.defineProperty(exports, "IssueType", { enumerable: true, get: function () { return CSpellReporter_1.IssueType; } });
-Object.defineProperty(exports, "MessageTypes", { enumerable: true, get: function () { return CSpellReporter_1.MessageTypes; } });
-//# sourceMappingURL=index.js.map

package/dist/suggestionCostsDef.js

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

package/dist/types.js

@@ -1,5 +0,0 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/ban-types */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map