@cspell/cspell-types 8.18.0 → 8.19.0

package/cspell.schema.json

@@ -252,6 +252,11 @@
           "description": "Path to the file, only for legacy dictionary definitions.",
           "markdownDescription": "Path to the file, only for legacy dictionary definitions."
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -298,6 +303,11 @@
         "dictionaryInformation": {
           "$ref": "#/definitions/DictionaryInformation"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -351,6 +361,11 @@
           "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
           "type": "string"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
@@ -439,6 +454,11 @@
           "markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n  \"color: colour\",\n  \"incase: in case, encase\",\n  \"canot->cannot\",\n  \"cancelled->canceled\"\n]\n```",
           "type": "array"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
           "items": {
@@ -512,6 +532,11 @@
           "markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n  \"color: colour\",\n  \"incase: in case, encase\",\n  \"canot->cannot\",\n  \"cancelled->canceled\"\n]\n```",
           "type": "array"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
           "items": {
@@ -585,6 +610,11 @@
           "markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n  \"color: colour\",\n  \"incase: in case, encase\",\n  \"canot->cannot\",\n  \"cancelled->canceled\"\n]\n```",
           "type": "array"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
           "items": {
@@ -658,6 +688,11 @@
           "markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n  \"color: colour\",\n  \"incase: in case, encase\",\n  \"canot->cannot\",\n  \"cancelled->canceled\"\n]\n```",
           "type": "array"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
           "items": {
@@ -723,6 +758,11 @@
           "markdownDescription": "Optional description of the contents / purpose of the dictionary.",
           "type": "string"
         },
+        "ignoreForbiddenWords": {
+          "description": "Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.",
+          "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"
+        },
         "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",

package/dist/index.d.mts

@@ -561,6 +561,14 @@ interface DictionaryDefinitionBase {
      * possible suggestions.
      */
     noSuggest?: boolean | undefined;
+    /**
+     * Some dictionaries may contain forbidden words to prevent compounding from generating
+     * words that are not valid in the language. These are often
+     * words that are used in other languages or might be generated through compounding.
+     * This setting allows flagged words to be ignored when checking the dictionary.
+     * The effect is similar to the word not being in the dictionary.
+     */
+    ignoreForbiddenWords?: boolean | undefined;
     /**
      * Type of file:
      * - S - single word per line,
@@ -620,6 +628,11 @@ interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, Inlin
      * @hidden
      */
     noSuggest?: DictionaryDefinitionBase['noSuggest'];
+    /**
+     * Not used
+     * @hidden
+     */
+    ignoreForbiddenWords?: undefined;
 }
 interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
     words: string[];

package/dist/index.d.ts

@@ -561,6 +561,14 @@ interface DictionaryDefinitionBase {
      * possible suggestions.
      */
     noSuggest?: boolean | undefined;
+    /**
+     * Some dictionaries may contain forbidden words to prevent compounding from generating
+     * words that are not valid in the language. These are often
+     * words that are used in other languages or might be generated through compounding.
+     * This setting allows flagged words to be ignored when checking the dictionary.
+     * The effect is similar to the word not being in the dictionary.
+     */
+    ignoreForbiddenWords?: boolean | undefined;
     /**
      * Type of file:
      * - S - single word per line,
@@ -620,6 +628,11 @@ interface DictionaryDefinitionInlineBase extends DictionaryDefinitionBase, Inlin
      * @hidden
      */
     noSuggest?: DictionaryDefinitionBase['noSuggest'];
+    /**
+     * Not used
+     * @hidden
+     */
+    ignoreForbiddenWords?: undefined;
 }
 interface DictionaryDefinitionInlineWords extends DictionaryDefinitionInlineBase, Required<Pick<InlineDictionary, 'words'>> {
     words: string[];

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "8.18.0",
+  "version": "8.19.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "sideEffects": false,
@@ -89,5 +89,5 @@
     "node": ">=18"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types#readme",
-  "gitHead": "6c7297918e9ff4f1c4fa1501d119d58bf4ce2237"
+  "gitHead": "ebfecabea342ba34ee368178f3864a7a194936d5"
 }