@cspell/cspell-types 6.24.0 → 6.25.0

package/cspell.schema.json

@@ -395,6 +395,13 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
+        "suggestWords": {
+          "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -451,6 +458,13 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
+        "suggestWords": {
+          "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -507,6 +521,13 @@
           "$ref": "#/definitions/ReplaceMap",
           "description": "Replacement pairs."
         },
+        "suggestWords": {
+          "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
@@ -953,6 +974,13 @@
           },
           "type": "array"
         },
+        "suggestWords": {
+          "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "words": {
           "description": "List of words to be considered correct.",
           "items": {
@@ -1132,6 +1160,13 @@
           },
           "type": "array"
         },
+        "suggestWords": {
+          "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "suggestionNumChanges": {
           "default": 3,
           "description": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
@@ -1649,6 +1684,13 @@
       "description": "Delay in ms after a document has changed before checking it for spelling errors.",
       "type": "number"
     },
+    "suggestWords": {
+      "description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)     - `word: suggestion`     - `word->suggestion`\n- Multiple suggestions (not auto fixable)    - `word: first, second, third`    - `word->first, second, third`",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
     "suggestionNumChanges": {
       "default": 3,
       "description": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",

package/dist/cjs/InlineDictionary.d.ts

@@ -26,5 +26,19 @@ export interface InlineDictionary {
      * 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/cjs/Parser/InlineDictionary.d.ts

@@ -26,5 +26,19 @@ export interface InlineDictionary {
      * 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/cjs/index.cjs

@@ -42,6 +42,7 @@ const ConfigFields = {
     spellCheckDelayMs: 'spellCheckDelayMs',
     suggestionNumChanges: 'suggestionNumChanges',
     suggestionsTimeout: 'suggestionsTimeout',
+    suggestWords: 'suggestWords',
     useGitignore: 'useGitignore',
     usePnP: 'usePnP',
     userWords: 'userWords',

package/dist/esm/InlineDictionary.d.ts

@@ -26,5 +26,19 @@ export interface InlineDictionary {
      * 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/configFields.js

@@ -40,6 +40,7 @@ export const ConfigFields = {
     spellCheckDelayMs: 'spellCheckDelayMs',
     suggestionNumChanges: 'suggestionNumChanges',
     suggestionsTimeout: 'suggestionsTimeout',
+    suggestWords: 'suggestWords',
     useGitignore: 'useGitignore',
     usePnP: 'usePnP',
     userWords: 'userWords',

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.24.0",
+  "version": "6.25.0",
   "description": "Types for cspell and cspell-lib",
   "type": "module",
   "main": "./dist/cjs/index.cjs",
@@ -92,7 +92,7 @@
     "jest": "^29.4.2",
     "ts-json-schema-generator": "^1.2.0",
     "typescript": "^4.9.5",
-    "vitest": "^0.28.4"
+    "vitest": "^0.28.5"
   },
-  "gitHead": "0d1e8bf9426cd0bfb814df4f61da12d8aee57ddd"
+  "gitHead": "fd7541605e07c43887191097d58ab58d87fac8fd"
 }