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

package/cspell.schema.json

@@ -354,6 +354,12 @@
           "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
           "type": "boolean"
         },
+        "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`.",
+          "since": "10.3.0"
+        },
         "name": {
           "$ref": "#/definitions/DictionaryId",
           "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -417,6 +423,12 @@
           "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
           "type": "boolean"
         },
+        "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`.",
+          "since": "10.3.0"
+        },
         "name": {
           "$ref": "#/definitions/DictionaryId",
           "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -487,6 +499,12 @@
           "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
           "type": "boolean"
         },
+        "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`.",
+          "since": "10.3.0"
+        },
         "name": {
           "$ref": "#/definitions/DictionaryId",
           "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -817,6 +835,12 @@
           "markdownDescription": "Some dictionaries may contain forbidden words to prevent compounding from generating\nwords that are not valid in the language. These are often\nwords that are used in other languages or might be generated through compounding.\nThis setting allows flagged words to be ignored when checking the dictionary.\nThe effect is similar to the word not being in the dictionary.",
           "type": "boolean"
         },
+        "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`.",
+          "since": "10.3.0"
+        },
         "name": {
           "$ref": "#/definitions/DictionaryId",
           "description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -975,6 +999,33 @@
       },
       "type": "object"
     },
+    "DictionaryKind": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/DictionaryKindWords"
+        },
+        {
+          "$ref": "#/definitions/DictionaryKindFlagWords"
+        },
+        {
+          "$ref": "#/definitions/DictionaryKindIgnoreWords"
+        }
+      ],
+      "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."
+    },
+    "DictionaryKindFlagWords": {
+      "const": "flag-words",
+      "type": "string"
+    },
+    "DictionaryKindIgnoreWords": {
+      "const": "ignore-words",
+      "type": "string"
+    },
+    "DictionaryKindWords": {
+      "const": "words",
+      "type": "string"
+    },
     "DictionaryNegRef": {
       "description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.",
       "markdownDescription": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.\n   Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\n   Overrides `!!<dictionary_name>`.",

package/dist/index.d.mts

@@ -784,6 +784,16 @@ interface DictionaryDefinitionBase {
    * possible suggestions.
    */
   noSuggest?: boolean | undefined;
+  /**
+   * Used to specify the type of dictionary being referenced.
+   * Values:
+   * - `words` - (default) A dictionary containing words.
+   * - `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`.
+   * @since 10.3.0
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * Some dictionaries may contain forbidden words to prevent compounding from generating
    * words that are not valid in the language. These are often
@@ -869,6 +879,10 @@ interface DictionaryDefinitionSimple extends DictionaryDefinitionBaseWithPathsHi
    * @hide
    */
   noSuggest?: boolean | undefined;
+  /**
+   * @hide
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * @hide
    */
@@ -910,6 +924,10 @@ interface HiddenFields {
    * @hide
    */
   noSuggest?: undefined;
+  /**
+   * @hide
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * Not used
    * @hide
@@ -1087,6 +1105,20 @@ type DictionaryRef = DictionaryId;
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
 type DictionaryNegRef = string;
+type DictionaryKindWords = "words";
+type DictionaryKindFlagWords = "flag-words";
+type DictionaryKindIgnoreWords = "ignore-words";
+/**
+ * The kind of dictionary.
+ *
+ * Used to specify the type of dictionary being referenced.
+ *
+ * Values:
+ * - `words` - A dictionary containing words.
+ * - `flag-words` - A dictionary containing flag words.
+ * - `ignore-words` - A dictionary containing words to ignore.
+ */
+type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords;
 //#endregion
 //#region src/features.d.ts
 /**

package/dist/index.d.ts

@@ -784,6 +784,16 @@ interface DictionaryDefinitionBase {
    * possible suggestions.
    */
   noSuggest?: boolean | undefined;
+  /**
+   * Used to specify the type of dictionary being referenced.
+   * Values:
+   * - `words` - (default) A dictionary containing words.
+   * - `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`.
+   * @since 10.3.0
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * Some dictionaries may contain forbidden words to prevent compounding from generating
    * words that are not valid in the language. These are often
@@ -869,6 +879,10 @@ interface DictionaryDefinitionSimple extends DictionaryDefinitionBaseWithPathsHi
    * @hide
    */
   noSuggest?: boolean | undefined;
+  /**
+   * @hide
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * @hide
    */
@@ -910,6 +924,10 @@ interface HiddenFields {
    * @hide
    */
   noSuggest?: undefined;
+  /**
+   * @hide
+   */
+  kind?: DictionaryKind | undefined;
   /**
    * Not used
    * @hide
@@ -1087,6 +1105,20 @@ type DictionaryRef = DictionaryId;
  * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
  */
 type DictionaryNegRef = string;
+type DictionaryKindWords = "words";
+type DictionaryKindFlagWords = "flag-words";
+type DictionaryKindIgnoreWords = "ignore-words";
+/**
+ * The kind of dictionary.
+ *
+ * Used to specify the type of dictionary being referenced.
+ *
+ * Values:
+ * - `words` - A dictionary containing words.
+ * - `flag-words` - A dictionary containing flag words.
+ * - `ignore-words` - A dictionary containing words to ignore.
+ */
+type DictionaryKind = DictionaryKindWords | DictionaryKindFlagWords | DictionaryKindIgnoreWords;
 //#endregion
 //#region src/features.d.ts
 /**

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "10.2.2",
+  "version": "10.3.0-alpha.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": "22fae7ac63d4330c52fe97eebee743e3541f2e36"
+  "gitHead": "39297075c7a4946feb1a4f0a509e329cfb0b4f11"
 }