@cspell/cspell-types 7.3.3 → 7.3.4

package/cspell.schema.json

@@ -233,7 +233,7 @@
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -276,7 +276,7 @@
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -291,7 +291,7 @@
     },
     "DictionaryDefinitionCustom": {
       "additionalProperties": false,
-      "description": "For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file. Note: only plain text files with one word per line are supported at this moment.",
+      "description": "For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file.\n\nNote: only plain text files with one word per line are supported at this moment.",
       "properties": {
         "addWords": {
           "description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
@@ -329,12 +329,12 @@
               "type": "array"
             }
           ],
-          "description": "Defines the scope for when words will be added to the dictionary. Scope values: `user`, `workspace`, `folder`."
+          "description": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -370,7 +370,7 @@
           "type": "string"
         },
         "flagWords": {
-          "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
           "items": {
             "type": "string"
           },
@@ -396,16 +396,17 @@
           "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`",
+          "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.",
           "items": {
             "type": "string"
           },
+          "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
           "type": "array"
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -433,10 +434,11 @@
           "type": "string"
         },
         "flagWords": {
-          "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
           "items": {
             "type": "string"
           },
+          "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"
         },
         "ignoreWords": {
@@ -459,16 +461,17 @@
           "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`",
+          "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.",
           "items": {
             "type": "string"
           },
+          "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
           "type": "array"
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -496,10 +499,11 @@
           "type": "string"
         },
         "flagWords": {
-          "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
           "items": {
             "type": "string"
           },
+          "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"
         },
         "ignoreWords": {
@@ -522,16 +526,17 @@
           "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`",
+          "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.",
           "items": {
             "type": "string"
           },
+          "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
           "type": "array"
         },
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -577,7 +582,7 @@
         "type": {
           "$ref": "#/definitions/DictionaryFileTypes",
           "default": "S",
-          "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C is the slowest to load due to the need to split each line based upon code splitting rules."
+          "description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
         },
         "useCompounds": {
           "description": "Use Compounds.",
@@ -620,7 +625,8 @@
               "type": "array"
             }
           ],
-          "description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
+          "description": "The accent characters.",
+          "markdownDescription": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
         },
         "adjustments": {
           "description": "A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.",
@@ -757,7 +763,8 @@
       "additionalProperties": false,
       "properties": {
         "aff": {
-          "description": "Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(IJ) ```",
+          "description": "Selected Hunspell AFF content.\nThe content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV",
+          "markdownDescription": "Selected Hunspell AFF content.\nThe content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample:\n```hunspell\n# Comment\nTRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`\nMAP aàâäAÀÂÄ\nMAP eéèêëEÉÈÊË\nMAP iîïyIÎÏY\nMAP oôöOÔÖ\nMAP (IJ)(IJ)\n```",
           "type": "string"
         },
         "costs": {
@@ -855,7 +862,8 @@
       "properties": {
         "allowCompoundWords": {
           "default": false,
-          "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
+          "description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
+          "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
           "type": "boolean"
         },
         "caseSensitive": {
@@ -868,10 +876,11 @@
           "type": "string"
         },
         "dictionaries": {
-          "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
+          "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
           "items": {
             "$ref": "#/definitions/DictionaryReference"
           },
+          "markdownDescription": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
           "type": "array"
         },
         "dictionaryDefinitions": {
@@ -887,10 +896,11 @@
           "type": "boolean"
         },
         "flagWords": {
-          "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
           "items": {
             "type": "string"
           },
+          "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"
         },
         "id": {
@@ -899,7 +909,8 @@
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+          "description": "List of regular expression patterns or pattern names to exclude from spell checking.",
+          "markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n  - >-\n   /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "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`.",
@@ -910,7 +921,8 @@
         },
         "includeRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+          "description": "List of regular expression patterns or defined pattern names to match for spell checking.",
+          "markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "languageId": {
           "$ref": "#/definitions/MatchingFileType",
@@ -958,17 +970,19 @@
           "type": "array"
         },
         "patterns": {
-          "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [   {     \"name\": \"comment-single-line\",     \"pattern\": \"/#.*​/g\"   },   {     \"name\": \"comment-multi-line\",     \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"   },   // You can also combine multiple named patterns into one single named pattern   {     \"name\": \"comments\",     \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]   } ] ```",
+          "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
           "items": {
             "$ref": "#/definitions/RegExpPatternDefinition"
           },
+          "markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n  {\n    \"name\": \"comment-single-line\",\n    \"pattern\": \"/#.*​/g\"\n  },\n  {\n    \"name\": \"comment-multi-line\",\n    \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n  },\n  // You can also combine multiple named patterns into one single named pattern\n  {\n    \"name\": \"comments\",\n    \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n  }\n]\n```",
           "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`",
+          "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.",
           "items": {
             "type": "string"
           },
+          "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
           "type": "array"
         },
         "words": {
@@ -1006,7 +1020,8 @@
       "properties": {
         "allowCompoundWords": {
           "default": false,
-          "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
+          "description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
+          "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
           "type": "boolean"
         },
         "caseSensitive": {
@@ -1019,10 +1034,11 @@
           "type": "string"
         },
         "dictionaries": {
-          "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
+          "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
           "items": {
             "$ref": "#/definitions/DictionaryReference"
           },
+          "markdownDescription": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
           "type": "array"
         },
         "dictionaryDefinitions": {
@@ -1036,7 +1052,7 @@
           "items": {
             "$ref": "#/definitions/LanguageIdSingle"
           },
-          "markdownDescription": "Enable / Disable checking file types (languageIds).\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
+          "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
           "scope": "resource",
           "title": "File Types to Check",
           "type": "array",
@@ -1069,10 +1085,11 @@
           "description": "Glob pattern or patterns to match against."
         },
         "flagWords": {
-          "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+          "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
           "items": {
             "type": "string"
           },
+          "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"
         },
         "id": {
@@ -1081,7 +1098,8 @@
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+          "description": "List of regular expression patterns or pattern names to exclude from spell checking.",
+          "markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n  - >-\n   /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "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`.",
@@ -1092,7 +1110,8 @@
         },
         "includeRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+          "description": "List of regular expression patterns or defined pattern names to match for spell checking.",
+          "markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "language": {
           "$ref": "#/definitions/LocaleId",
@@ -1103,10 +1122,11 @@
           "description": "Sets the programming language id to match file type."
         },
         "languageSettings": {
-          "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
+          "description": "Additional settings for individual languages.",
           "items": {
             "$ref": "#/definitions/LanguageSetting"
           },
+          "markdownDescription": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
           "type": "array"
         },
         "loadDefaultConfiguration": {
@@ -1146,10 +1166,11 @@
           "type": "number"
         },
         "patterns": {
-          "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [   {     \"name\": \"comment-single-line\",     \"pattern\": \"/#.*​/g\"   },   {     \"name\": \"comment-multi-line\",     \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"   },   // You can also combine multiple named patterns into one single named pattern   {     \"name\": \"comments\",     \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]   } ] ```",
+          "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
           "items": {
             "$ref": "#/definitions/RegExpPatternDefinition"
           },
+          "markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n  {\n    \"name\": \"comment-single-line\",\n    \"pattern\": \"/#.*​/g\"\n  },\n  {\n    \"name\": \"comment-multi-line\",\n    \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n  },\n  // You can also combine multiple named patterns into one single named pattern\n  {\n    \"name\": \"comments\",\n    \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n  }\n]\n```",
           "type": "array"
         },
         "pnpFiles": {
@@ -1164,15 +1185,17 @@
           "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`",
+          "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.",
           "items": {
             "type": "string"
           },
+          "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
           "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.",
+          "description": "The maximum number of changes allowed on a word to be considered a suggestions.",
+          "markdownDescription": "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.",
           "type": "number"
         },
         "suggestionsTimeout": {
@@ -1442,7 +1465,8 @@
     },
     "allowCompoundWords": {
       "default": false,
-      "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
+      "description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
+      "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
       "type": "boolean"
     },
     "cache": {
@@ -1459,10 +1483,11 @@
       "type": "string"
     },
     "dictionaries": {
-      "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
+      "description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
       "items": {
         "$ref": "#/definitions/DictionaryReference"
       },
+      "markdownDescription": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
       "type": "array"
     },
     "dictionaryDefinitions": {
@@ -1476,7 +1501,7 @@
       "items": {
         "$ref": "#/definitions/LanguageIdSingle"
       },
-      "markdownDescription": "Enable / Disable checking file types (languageIds).\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
+      "markdownDescription": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc       // enable checking for jsonc\n!json       // disable checking for json\nkotlin      // enable checking for kotlin\n```",
       "scope": "resource",
       "title": "File Types to Check",
       "type": "array",
@@ -1513,13 +1538,15 @@
       "items": {
         "$ref": "#/definitions/Glob"
       },
+      "markdownDescription": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
       "type": "array"
     },
     "flagWords": {
-      "description": "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: ```ts \"flagWords\": [   \"color: colour\",   \"incase: in case, encase\",   \"canot->cannot\",   \"cancelled->canceled\" ] ```",
+      "description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.",
       "items": {
         "type": "string"
       },
+      "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"
     },
     "gitignoreRoot": {
@@ -1538,7 +1565,8 @@
     },
     "globRoot": {
       "$ref": "#/definitions/FSPathResolvable",
-      "description": "The root to use for glob patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
+      "description": "The root to use for glob patterns found in this configuration.",
+      "markdownDescription": "The root to use for glob patterns found in this configuration.\nDefault: location of the configuration file.\n  For compatibility reasons, config files with version 0.1, the glob root will\n  default to be `${cwd}`.\n\nUse `globRoot` to define a different location.\n`globRoot` can be relative to the location of this configuration file.\nDefining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
     },
     "id": {
       "description": "Optional identifier.",
@@ -1553,7 +1581,8 @@
     },
     "ignoreRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
-      "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+      "description": "List of regular expression patterns or pattern names to exclude from spell checking.",
+      "markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n  - >-\n   /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
     },
     "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`.",
@@ -1574,11 +1603,13 @@
           "type": "array"
         }
       ],
-      "description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
+      "description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee https://cspell.org/configuration/imports/ for more details.",
+      "markdownDescription": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
     },
     "includeRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
-      "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
+      "description": "List of regular expression patterns or defined pattern names to match for spell checking.",
+      "markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
     },
     "language": {
       "$ref": "#/definitions/LocaleId",
@@ -1590,10 +1621,11 @@
       "description": "Forces the spell checker to assume a give language id. Used mainly as an Override."
     },
     "languageSettings": {
-      "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
+      "description": "Additional settings for individual languages.",
       "items": {
         "$ref": "#/definitions/LanguageSetting"
       },
+      "markdownDescription": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
       "type": "array"
     },
     "loadDefaultConfiguration": {
@@ -1638,17 +1670,19 @@
       "type": "number"
     },
     "overrides": {
-      "description": "Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript \"overrides\": [   // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:   {     \"filename\": \"**​/{*.hrr,*.crr}\",     \"languageId\": \"cpp\"   },   // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):   {     \"language\": \"nl\",     \"filename\": \"**​/dutch/**​/*.txt\"   } ] ```",
+      "description": "Overrides are used to apply settings for specific files in your project.",
       "items": {
         "$ref": "#/definitions/OverrideSettings"
       },
+      "markdownDescription": "Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript\n\"overrides\": [\n  // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:\n  {\n    \"filename\": \"**​/{*.hrr,*.crr}\",\n    \"languageId\": \"cpp\"\n  },\n  // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):\n  {\n    \"language\": \"nl\",\n    \"filename\": \"**​/dutch/**​/*.txt\"\n  }\n]\n```",
       "type": "array"
     },
     "patterns": {
-      "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [   {     \"name\": \"comment-single-line\",     \"pattern\": \"/#.*​/g\"   },   {     \"name\": \"comment-multi-line\",     \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"   },   // You can also combine multiple named patterns into one single named pattern   {     \"name\": \"comments\",     \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]   } ] ```",
+      "description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
       "items": {
         "$ref": "#/definitions/RegExpPatternDefinition"
       },
+      "markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n  {\n    \"name\": \"comment-single-line\",\n    \"pattern\": \"/#.*​/g\"\n  },\n  {\n    \"name\": \"comment-multi-line\",\n    \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n  },\n  // You can also combine multiple named patterns into one single named pattern\n  {\n    \"name\": \"comments\",\n    \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n  }\n]\n```",
       "type": "array"
     },
     "pnpFiles": {
@@ -1671,10 +1705,11 @@
       "default": [
         "default"
       ],
-      "description": "Define which reports to use. `default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.",
+      "description": "Define which reports to use.\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.",
       "items": {
         "$ref": "#/definitions/ReporterSettings"
       },
+      "markdownDescription": "Define which reports to use.\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.",
       "type": "array"
     },
     "showStatus": {
@@ -1688,15 +1723,17 @@
       "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`",
+      "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.",
       "items": {
         "type": "string"
       },
+      "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n    - `word: suggestion`\n    - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n   - `word: first, second, third`\n   - `word->first, second, third`",
       "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.",
+      "description": "The maximum number of changes allowed on a word to be considered a suggestions.",
+      "markdownDescription": "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.",
       "type": "number"
     },
     "suggestionsTimeout": {

package/dist/CSpellSettingsDef.d.ts

@@ -40,12 +40,20 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
     /** Words to add to global dictionary -- should only be in the user config file. */
     userWords?: string[];
     /**
+     * @markdownDescription
      * Allows this configuration to inherit configuration for one or more other files.
      *
      * See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.
+     *
+     * @description
+     * Allows this configuration to inherit configuration for one or more other files.
+     *
+     * See https://cspell.org/configuration/imports/ for more details.
+     *
      */
     import?: FsPath | FsPath[];
     /**
+     * @markdownDescription
      * The root to use for glob patterns found in this configuration.
      * Default: location of the configuration file.
      *   For compatibility reasons, config files with version 0.1, the glob root will
@@ -59,9 +67,17 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      * - `${cwd}` - will be replaced with the current working directory.
      * - `.` - will be the location of the containing configuration file.
      *
+     * @description
+     * The root to use for glob patterns found in this configuration.
      */
     globRoot?: FSPathResolvable;
     /**
+     * @markdownDescription
+     * Glob patterns of files to be checked.
+     *
+     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
+     *
+     * @description
      * Glob patterns of files to be checked.
      *
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
@@ -96,6 +112,17 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
      */
     readonly?: boolean;
     /**
+     * @markdownDescription
+     * Define which reports to use.
+     * `default` - is a special name for the default cli reporter.
+     *
+     * Examples:
+     * - `["default"]` - to use the default reporter
+     * - `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter.
+     * - `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]`
+     * - `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter.
+     *
+     * @description
      * Define which reports to use.
      * `default` - is a special name for the default cli reporter.
      *
@@ -138,6 +165,7 @@ export interface FileSettings extends ExtendableSettings, CommandLineSettings {
  */
 export interface ExtendableSettings extends Settings {
     /**
+     * @markdownDescription
      * Overrides are used to apply settings for specific files in your project.
      *
      * For example:
@@ -156,6 +184,8 @@ export interface ExtendableSettings extends Settings {
      *   }
      * ]
      * ```
+     * @description
+     * Overrides are used to apply settings for specific files in your project.
      */
     overrides?: OverrideSettings[];
 }
@@ -180,7 +210,9 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      * @uniqueItems true
      * @markdownDescription
      * Enable / Disable checking file types (languageIds).
+     *
      * These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
+     *
      * To disable a language, prefix with `!` as in `!json`,
      *
      * Example:
@@ -192,9 +224,13 @@ export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettin
      */
     enableFiletypes?: LanguageIdSingle[];
     /**
+     * @markdownDescription
      * Additional settings for individual languages.
      *
      * See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
+     *
+     * @description
+     * Additional settings for individual languages.
      */
     languageSettings?: LanguageSetting[];
     /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
@@ -223,12 +259,16 @@ export interface SuggestionsConfiguration {
      */
     suggestionsTimeout?: number;
     /**
+     * @markdownDescription
      * The maximum number of changes allowed on a word to be considered a suggestions.
      *
      * For example, appending an `s` onto `example` -> `examples` is considered 1 change.
      *
      * Range: between 1 and 5.
      *
+     * @description
+     * The maximum number of changes allowed on a word to be considered a suggestions.
+     *
      * @default 3
      */
     suggestionNumChanges?: number;
@@ -367,9 +407,13 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     enabled?: boolean;
     /**
+     * @markdownDescription
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *
-     * @default false
+     * @description
+     * True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.
+
+    * @default false
      */
     allowCompoundWords?: boolean;
     /**
@@ -396,6 +440,7 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     dictionaryDefinitions?: DictionaryDefinition[];
     /**
+     * @markdownDescription
      * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
      *
      * To remove a dictionary from the list, add `!` before the name.
@@ -404,6 +449,9 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *
      * See the [Dictionaries](https://cspell.org/docs/dictionaries/)
      * and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.
+     *
+     * @description
+     * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
      */
     dictionaries?: DictionaryReference[];
     /**
@@ -417,6 +465,7 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      */
     noSuggestDictionaries?: DictionaryReference[];
     /**
+     * @markdownDescription
      * List of regular expression patterns or pattern names to exclude from spell checking.
      *
      * Example: `["href"]` - to exclude html href pattern.
@@ -442,18 +491,24 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *
      * While you can create your own patterns, you can also leverage several patterns that are
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
+     * @description
+     * List of regular expression patterns or pattern names to exclude from spell checking.
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
+     * @markdownDescription
      * List of regular expression patterns or defined pattern names to match for spell checking.
      *
      * If this property is defined, only text matching the included patterns will be checked.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
+     * @description
+     * List of regular expression patterns or defined pattern names to match for spell checking.
      */
     includeRegExpList?: RegExpPatternList;
     /**
+     * @markdownDescription
      * Defines a list of patterns that can be used with the `ignoreRegExpList` and
      * `includeRegExpList` options.
      *
@@ -477,6 +532,9 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      *   }
      * ]
      * ```
+     * @description
+     * Defines a list of patterns that can be used with the `ignoreRegExpList` and
+     * `includeRegExpList` options.
      */
     patterns?: RegExpPatternDefinition[];
 }

package/dist/DictionaryDefinition.d.ts

@@ -32,10 +32,12 @@ export interface DictionaryDefinitionBase {
     noSuggest?: boolean;
     /**
      * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
+     * - S - single word per line,
+     * - W - each line can contain one or more words separated by space,
+     * - C - each line is treated like code (Camel Case is allowed).
+     *
      * Default is S.
+     *
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
      * @default "S"
      */
@@ -123,10 +125,12 @@ export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
     file: FsDictionaryPath;
     /**
      * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
+     * - S - single word per line,
+     * - W - each line can contain one or more words separated by space,
+     * - C - each line is treated like code (Camel Case is allowed).
+     *
      * Default is S.
+     *
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
      * @default "S"
      */
@@ -145,6 +149,7 @@ export type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
  * `user`, `workspace`, or `folder`.
  * When `addWords` is true, indicates that the spell checker can add words
  * to the file.
+ *
  * Note: only plain text files with one word per line are supported at this moment.
  */
 export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
@@ -152,6 +157,7 @@ export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferre
     path: CustomDictionaryPath;
     /**
      * Defines the scope for when words will be added to the dictionary.
+     *
      * Scope values: `user`, `workspace`, `folder`.
      */
     scope?: CustomDictionaryScope | CustomDictionaryScope[];

package/dist/DictionaryInformation.d.ts

@@ -17,6 +17,8 @@ export interface DictionaryInformation {
      */
     alphabet?: CharacterSet | CharacterSetCosts[];
     /**
+     * The accent characters.
+     * @markdownDescription
      * The accent characters.
      *
      * Default: `"\u0300-\u0341"`
@@ -52,6 +54,7 @@ export interface DictionaryInformation {
 }
 export interface HunspellInformation {
     /**
+     * @markdownDescription
      * Selected Hunspell AFF content.
      * The content must be UTF-8
      *
@@ -73,6 +76,18 @@ export interface HunspellInformation {
      * MAP oôöOÔÖ
      * MAP (IJ)(IJ)
      * ```
+     *
+     * @description
+     * Selected Hunspell AFF content.
+     * The content must be UTF-8
+     *
+     * Sections:
+     * - TRY
+     * - MAP
+     * - REP
+     * - KEY
+     * - ICONV
+     * - OCONV
      */
     aff: HunspellAffContent;
     /** The costs to apply when using the hunspell settings */

package/dist/InlineDictionary.d.ts

@@ -4,6 +4,8 @@ export interface InlineDictionary {
      */
     words?: string[];
     /**
+     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
+     * @markdownDescription
      * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
      *
      * Format of `flagWords`
@@ -27,6 +29,11 @@ export interface InlineDictionary {
      */
     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.
+     *
+     * @markdownDescription
      * 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.

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.3.3",
+  "version": "7.3.4",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -52,13 +52,11 @@
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "build": "pnpm build:tsc && pnpm run build-schema",
-    "build:tsc": "tsc -b tsconfig.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 ../..",
+    "build:tsc": "tsc -p tsconfig.json",
+    "build-schema": "pnpm build-cspell-schema",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
-    "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.js",
+    "test": "vitest run",
     "prepare": "echo Skip Building Types"
   },
   "repository": {
@@ -86,9 +84,5 @@
   "engines": {
     "node": ">=16"
   },
-  "devDependencies": {
-    "ajv-cli": "^5.0.0",
-    "ts-json-schema-generator": "^1.3.0"
-  },
-  "gitHead": "da65ffafaa6a039cedc52d9e029c53ddd273a1fb"
+  "gitHead": "7849a4ff2561453653fae9b9067b39252aeb773f"
 }

package/ajv.config.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const keywords = ['deprecationMessage', 'markdownDescription', 'scope'];
-
-function addKeywords(ajv) {
-    for (const keyword of keywords) {
-        ajv.addKeyword(keyword);
-    }
-}
-
-module.exports = addKeywords;