@cspell/cspell-types 10.3.0-alpha.0 → 10.3.0

package/cspell.schema.json

@@ -356,8 +356,8 @@
         },
         "kind": {
           "$ref": "#/definitions/DictionaryKind",
-          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.",
-          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.",
+          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the    dictionary will be treated like `suggestWords`.",
+          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the\n   dictionary will be treated like `suggestWords`.",
           "since": "10.3.0"
         },
         "name": {
@@ -425,8 +425,8 @@
         },
         "kind": {
           "$ref": "#/definitions/DictionaryKind",
-          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.",
-          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.",
+          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the    dictionary will be treated like `suggestWords`.",
+          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the\n   dictionary will be treated like `suggestWords`.",
           "since": "10.3.0"
         },
         "name": {
@@ -501,8 +501,8 @@
         },
         "kind": {
           "$ref": "#/definitions/DictionaryKind",
-          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.",
-          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.",
+          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the    dictionary will be treated like `suggestWords`.",
+          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the\n   dictionary will be treated like `suggestWords`.",
           "since": "10.3.0"
         },
         "name": {
@@ -837,8 +837,8 @@
         },
         "kind": {
           "$ref": "#/definitions/DictionaryKind",
-          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.",
-          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.",
+          "description": "Used to specify the type of dictionary being referenced. Values:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.    This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the    dictionary will be treated like `suggestWords`.",
+          "markdownDescription": "Used to specify the type of dictionary being referenced.\nValues:\n- `words` - (default) A dictionary containing words.\n- `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.\n- `ignore-words` - A dictionary containing words to ignore.\n   This is the same as setting `noSuggest` to `true`.\n- `suggest-words` - A dictionary containing suggested word corrections. Words found in the\n   dictionary will be treated like `suggestWords`.",
           "since": "10.3.0"
         },
         "name": {
@@ -1009,10 +1009,13 @@
         },
         {
           "$ref": "#/definitions/DictionaryKindIgnoreWords"
+        },
+        {
+          "$ref": "#/definitions/DictionaryKindSuggestWords"
         }
       ],
-      "description": "The kind of dictionary.\n\nUsed to specify the type of dictionary being referenced.\n\nValues:\n- `words` - A dictionary containing words.\n- `flag-words` - A dictionary containing flag words.\n- `ignore-words` - A dictionary containing words to ignore.",
-      "markdownDescription": "The kind of dictionary.\n\nUsed to specify the type of dictionary being referenced.\n\nValues:\n- `words` - A dictionary containing words.\n- `flag-words` - A dictionary containing flag words.\n- `ignore-words` - A dictionary containing words to ignore."
+      "description": "The kind of dictionary.\n\nUsed to specify the type of dictionary being referenced.\n\nValues:\n- `words` - A dictionary containing words.\n- `flag-words` - A dictionary containing flag words.\n- `ignore-words` - A dictionary containing words to ignore.\n- `suggest-words` - A dictionary containing suggested word corrections.",
+      "markdownDescription": "The kind of dictionary.\n\nUsed to specify the type of dictionary being referenced.\n\nValues:\n- `words` - A dictionary containing words.\n- `flag-words` - A dictionary containing flag words.\n- `ignore-words` - A dictionary containing words to ignore.\n- `suggest-words` - A dictionary containing suggested word corrections."
     },
     "DictionaryKindFlagWords": {
       "const": "flag-words",
@@ -1022,6 +1025,10 @@
       "const": "ignore-words",
       "type": "string"
     },
+    "DictionaryKindSuggestWords": {
+      "const": "suggest-words",
+      "type": "string"
+    },
     "DictionaryKindWords": {
       "const": "words",
       "type": "string"

package/dist/index.d.mts

@@ -791,6 +791,8 @@ interface DictionaryDefinitionBase {
    * - `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.
    * - `ignore-words` - A dictionary containing words to ignore.
    *    This is the same as setting `noSuggest` to `true`.
+   * - `suggest-words` - A dictionary containing suggested word corrections. Words found in the
+   *    dictionary will be treated like `suggestWords`.
    * @since 10.3.0
    */
   kind?: DictionaryKind | undefined;
@@ -1108,6 +1110,7 @@ type DictionaryNegRef = string;
 type DictionaryKindWords = "words";
 type DictionaryKindFlagWords = "flag-words";
 type DictionaryKindIgnoreWords = "ignore-words";
+type DictionaryKindSuggestWords = "suggest-words";
 /**
  * The kind of dictionary.
  *
@@ -1117,8 +1120,9 @@ type DictionaryKindIgnoreWords = "ignore-words";
  * - `words` - A dictionary containing words.
  * - `flag-words` - A dictionary containing flag words.
  * - `ignore-words` - A dictionary containing words to ignore.
+ * - `suggest-words` - A dictionary containing suggested word corrections.
  */
-type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords;
+type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords | DictionaryKindSuggestWords;
 //#endregion
 //#region src/features.d.ts
 /**

package/dist/index.d.ts

@@ -791,6 +791,8 @@ interface DictionaryDefinitionBase {
    * - `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`.
    * - `ignore-words` - A dictionary containing words to ignore.
    *    This is the same as setting `noSuggest` to `true`.
+   * - `suggest-words` - A dictionary containing suggested word corrections. Words found in the
+   *    dictionary will be treated like `suggestWords`.
    * @since 10.3.0
    */
   kind?: DictionaryKind | undefined;
@@ -1108,6 +1110,7 @@ type DictionaryNegRef = string;
 type DictionaryKindWords = "words";
 type DictionaryKindFlagWords = "flag-words";
 type DictionaryKindIgnoreWords = "ignore-words";
+type DictionaryKindSuggestWords = "suggest-words";
 /**
  * The kind of dictionary.
  *
@@ -1117,8 +1120,9 @@ type DictionaryKindIgnoreWords = "ignore-words";
  * - `words` - A dictionary containing words.
  * - `flag-words` - A dictionary containing flag words.
  * - `ignore-words` - A dictionary containing words to ignore.
+ * - `suggest-words` - A dictionary containing suggested word corrections.
  */
-type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords;
+type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords | DictionaryKindSuggestWords;
 //#endregion
 //#region src/features.d.ts
 /**

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "10.3.0-alpha.0",
+  "version": "10.3.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -85,5 +85,5 @@
     "node": ">=22.18.0"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "39297075c7a4946feb1a4f0a509e329cfb0b4f11"
+  "gitHead": "d8abd59fa15da6da47955eb6fcca180e8b5cbdbf"
 }