diff --git a/docs/types/.cspell.json b/docs/types/.cspell.json index 5b15eae39dd..46f4828eb52 100644 --- a/docs/types/.cspell.json +++ b/docs/types/.cspell.json @@ -1,5 +1,7 @@ { + "version": "0.2", "dictionaries": ["custom-dictionary"], + "ignorePaths": ["/cspell-types"], "dictionaryDefinitions": [ { "name": "custom-dictionary", diff --git a/docs/types/cspell-types/interfaces/BaseSetting.md b/docs/types/cspell-types/interfaces/BaseSetting.md index 49c576d82a5..419f2d83072 100644 --- a/docs/types/cspell-types/interfaces/BaseSetting.md +++ b/docs/types/cspell-types/interfaces/BaseSetting.md @@ -42,7 +42,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -56,7 +56,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -68,7 +68,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -83,7 +83,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -95,7 +95,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -109,7 +109,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -121,7 +121,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -133,7 +133,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -147,7 +147,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -159,7 +159,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -172,7 +172,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -184,7 +184,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -202,7 +202,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -214,7 +214,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -226,4 +226,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/CSpellSettings.md b/docs/types/cspell-types/interfaces/CSpellSettings.md index aa415f071b7..d516495da63 100644 --- a/docs/types/cspell-types/interfaces/CSpellSettings.md +++ b/docs/types/cspell-types/interfaces/CSpellSettings.md @@ -50,6 +50,8 @@ - [readonly](CSpellSettings.md#readonly) - [showStatus](CSpellSettings.md#showstatus) - [spellCheckDelayMs](CSpellSettings.md#spellcheckdelayms) +- [suggestionNumChanges](CSpellSettings.md#suggestionnumchanges) +- [suggestionsTimeout](CSpellSettings.md#suggestionstimeout) - [usePnP](CSpellSettings.md#usepnp) - [userWords](CSpellSettings.md#userwords) - [version](CSpellSettings.md#version) @@ -63,7 +65,7 @@ #### Defined in -[settings/CSpellSettingsDef.ts:12](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L12) +[settings/CSpellSettingsDef.ts:12](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L12) ___ @@ -81,7 +83,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -99,7 +101,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -115,7 +117,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -134,7 +136,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -150,7 +152,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -182,7 +184,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -200,7 +202,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -216,7 +218,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -233,7 +235,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) +[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) ___ @@ -249,7 +251,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -276,7 +278,7 @@ Special Values: #### Defined in -[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) +[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) ___ @@ -292,7 +294,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -309,7 +311,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) +[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) ___ @@ -327,7 +329,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -343,7 +345,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -359,7 +361,7 @@ Other settings files to be included #### Defined in -[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) +[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) ___ @@ -376,7 +378,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -398,7 +400,7 @@ Example: "en,nl" to enable both English and Dutch #### Defined in -[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) +[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) ___ @@ -414,7 +416,7 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid #### Defined in -[settings/CSpellSettingsDef.ts:149](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L149) +[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) ___ @@ -430,7 +432,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -448,7 +450,7 @@ The maximum number of times the same word can be flagged as an error in a file. #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -466,7 +468,7 @@ The maximum number of problems to report in a file. #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -484,7 +486,7 @@ The minimum length of a word before checking it against a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -500,7 +502,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -518,7 +520,7 @@ Prevents searching for local configuration when checking individual documents. #### Defined in -[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) +[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) ___ @@ -540,7 +542,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -558,7 +560,7 @@ Number of suggestions to make #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -574,7 +576,7 @@ Overrides to apply based upon the file path. #### Defined in -[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) +[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) ___ @@ -590,7 +592,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -608,7 +610,7 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) ___ @@ -628,7 +630,7 @@ modifying the file to add words and other configuration. #### Defined in -[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) +[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) ___ @@ -646,7 +648,7 @@ Show status #### Defined in -[settings/CSpellSettingsDef.ts:212](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L212) +[settings/CSpellSettingsDef.ts:232](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L232) ___ @@ -664,7 +666,47 @@ Delay in ms after a document has changed before checking it for spelling errors. #### Defined in -[settings/CSpellSettingsDef.ts:218](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L218) +[settings/CSpellSettingsDef.ts:238](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L238) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[FileSettings](FileSettings.md).[suggestionNumChanges](FileSettings.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[FileSettings](FileSettings.md).[suggestionsTimeout](FileSettings.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -686,7 +728,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -702,7 +744,7 @@ Words to add to global dictionary -- should only be in the user config file. #### Defined in -[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) +[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) ___ @@ -720,7 +762,7 @@ Configuration format version of the settings file. #### Defined in -[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) +[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) ___ @@ -736,4 +778,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/CSpellSettingsWithSourceTrace.md b/docs/types/cspell-types/interfaces/CSpellSettingsWithSourceTrace.md index 5116f050cd3..4e6913c7b52 100644 --- a/docs/types/cspell-types/interfaces/CSpellSettingsWithSourceTrace.md +++ b/docs/types/cspell-types/interfaces/CSpellSettingsWithSourceTrace.md @@ -49,6 +49,8 @@ - [showStatus](CSpellSettingsWithSourceTrace.md#showstatus) - [source](CSpellSettingsWithSourceTrace.md#source) - [spellCheckDelayMs](CSpellSettingsWithSourceTrace.md#spellcheckdelayms) +- [suggestionNumChanges](CSpellSettingsWithSourceTrace.md#suggestionnumchanges) +- [suggestionsTimeout](CSpellSettingsWithSourceTrace.md#suggestionstimeout) - [usePnP](CSpellSettingsWithSourceTrace.md#usepnp) - [userWords](CSpellSettingsWithSourceTrace.md#userwords) - [version](CSpellSettingsWithSourceTrace.md#version) @@ -66,7 +68,7 @@ #### Defined in -[settings/CSpellSettingsDef.ts:12](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L12) +[settings/CSpellSettingsDef.ts:12](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L12) ___ @@ -76,7 +78,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:23](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L23) +[settings/CSpellSettingsDef.ts:23](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L23) ___ @@ -86,7 +88,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:24](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L24) +[settings/CSpellSettingsDef.ts:24](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L24) ___ @@ -104,7 +106,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -122,7 +124,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -138,7 +140,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -157,7 +159,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -173,7 +175,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -205,7 +207,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -223,7 +225,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -239,7 +241,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -256,7 +258,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) +[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) ___ @@ -272,7 +274,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -299,7 +301,7 @@ Special Values: #### Defined in -[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) +[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) ___ @@ -315,7 +317,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -332,7 +334,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) +[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) ___ @@ -350,7 +352,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -366,7 +368,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -382,7 +384,7 @@ Other settings files to be included #### Defined in -[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) +[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) ___ @@ -399,7 +401,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -421,7 +423,7 @@ Example: "en,nl" to enable both English and Dutch #### Defined in -[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) +[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) ___ @@ -437,7 +439,7 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid #### Defined in -[settings/CSpellSettingsDef.ts:149](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L149) +[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) ___ @@ -453,7 +455,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -471,7 +473,7 @@ The maximum number of times the same word can be flagged as an error in a file. #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -489,7 +491,7 @@ The maximum number of problems to report in a file. #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -507,7 +509,7 @@ The minimum length of a word before checking it against a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -523,7 +525,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -541,7 +543,7 @@ Prevents searching for local configuration when checking individual documents. #### Defined in -[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) +[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) ___ @@ -563,7 +565,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -581,7 +583,7 @@ Number of suggestions to make #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -597,7 +599,7 @@ Overrides to apply based upon the file path. #### Defined in -[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) +[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) ___ @@ -613,7 +615,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -631,7 +633,7 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) ___ @@ -651,7 +653,7 @@ modifying the file to add words and other configuration. #### Defined in -[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) +[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) ___ @@ -669,7 +671,7 @@ Show status #### Defined in -[settings/CSpellSettingsDef.ts:212](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L212) +[settings/CSpellSettingsDef.ts:232](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L232) ___ @@ -679,7 +681,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:22](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L22) +[settings/CSpellSettingsDef.ts:22](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L22) ___ @@ -697,7 +699,47 @@ Delay in ms after a document has changed before checking it for spelling errors. #### Defined in -[settings/CSpellSettingsDef.ts:218](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L218) +[settings/CSpellSettingsDef.ts:238](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L238) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[CSpellSettings](CSpellSettings.md).[suggestionNumChanges](CSpellSettings.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[CSpellSettings](CSpellSettings.md).[suggestionsTimeout](CSpellSettings.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -719,7 +761,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -735,7 +777,7 @@ Words to add to global dictionary -- should only be in the user config file. #### Defined in -[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) +[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) ___ @@ -753,7 +795,7 @@ Configuration format version of the settings file. #### Defined in -[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) +[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) ___ @@ -769,4 +811,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/DictionaryDefinitionAlternate.md b/docs/types/cspell-types/interfaces/DictionaryDefinitionAlternate.md index 62f74aaf0b0..7cd8a9feab2 100644 --- a/docs/types/cspell-types/interfaces/DictionaryDefinitionAlternate.md +++ b/docs/types/cspell-types/interfaces/DictionaryDefinitionAlternate.md @@ -39,7 +39,7 @@ Optional description #### Defined in -[settings/CSpellSettingsDef.ts:332](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L332) +[settings/CSpellSettingsDef.ts:352](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L352) ___ @@ -55,7 +55,7 @@ Path to the file, only for legacy dictionary definitions #### Defined in -[settings/CSpellSettingsDef.ts:376](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L376) +[settings/CSpellSettingsDef.ts:396](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L396) ___ @@ -78,7 +78,7 @@ Name Format: #### Defined in -[settings/CSpellSettingsDef.ts:330](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L330) +[settings/CSpellSettingsDef.ts:350](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L350) ___ @@ -100,7 +100,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:346](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L346) +[settings/CSpellSettingsDef.ts:366](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L366) ___ @@ -116,7 +116,7 @@ Replacement pairs #### Defined in -[settings/CSpellSettingsDef.ts:334](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L334) +[settings/CSpellSettingsDef.ts:354](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L354) ___ @@ -132,4 +132,4 @@ Use Compounds #### Defined in -[settings/CSpellSettingsDef.ts:336](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L336) +[settings/CSpellSettingsDef.ts:356](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L356) diff --git a/docs/types/cspell-types/interfaces/DictionaryDefinitionBase.md b/docs/types/cspell-types/interfaces/DictionaryDefinitionBase.md index 665e79d77b9..407665b5a47 100644 --- a/docs/types/cspell-types/interfaces/DictionaryDefinitionBase.md +++ b/docs/types/cspell-types/interfaces/DictionaryDefinitionBase.md @@ -30,7 +30,7 @@ Optional description #### Defined in -[settings/CSpellSettingsDef.ts:332](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L332) +[settings/CSpellSettingsDef.ts:352](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L352) ___ @@ -49,7 +49,7 @@ Name Format: #### Defined in -[settings/CSpellSettingsDef.ts:330](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L330) +[settings/CSpellSettingsDef.ts:350](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L350) ___ @@ -67,7 +67,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:346](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L346) +[settings/CSpellSettingsDef.ts:366](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L366) ___ @@ -79,7 +79,7 @@ Replacement pairs #### Defined in -[settings/CSpellSettingsDef.ts:334](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L334) +[settings/CSpellSettingsDef.ts:354](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L354) ___ @@ -91,4 +91,4 @@ Use Compounds #### Defined in -[settings/CSpellSettingsDef.ts:336](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L336) +[settings/CSpellSettingsDef.ts:356](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L356) diff --git a/docs/types/cspell-types/interfaces/DictionaryDefinitionCustom.md b/docs/types/cspell-types/interfaces/DictionaryDefinitionCustom.md index a82ca901c82..8c1e07cd962 100644 --- a/docs/types/cspell-types/interfaces/DictionaryDefinitionCustom.md +++ b/docs/types/cspell-types/interfaces/DictionaryDefinitionCustom.md @@ -37,7 +37,7 @@ When `true`, let's the spell checker know that words can be added to this dictio #### Defined in -[settings/CSpellSettingsDef.ts:429](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L429) +[settings/CSpellSettingsDef.ts:449](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L449) ___ @@ -53,7 +53,7 @@ Optional description #### Defined in -[settings/CSpellSettingsDef.ts:332](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L332) +[settings/CSpellSettingsDef.ts:352](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L352) ___ @@ -76,7 +76,7 @@ Name Format: #### Defined in -[settings/CSpellSettingsDef.ts:330](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L330) +[settings/CSpellSettingsDef.ts:350](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L350) ___ @@ -98,7 +98,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:346](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L346) +[settings/CSpellSettingsDef.ts:366](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L366) ___ @@ -114,7 +114,7 @@ Path to custom dictionary text file. #### Defined in -[settings/CSpellSettingsDef.ts:418](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L418) +[settings/CSpellSettingsDef.ts:438](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L438) ___ @@ -130,7 +130,7 @@ Replacement pairs #### Defined in -[settings/CSpellSettingsDef.ts:334](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L334) +[settings/CSpellSettingsDef.ts:354](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L354) ___ @@ -143,7 +143,7 @@ Scope values: `user`, `workspace`, `folder` #### Defined in -[settings/CSpellSettingsDef.ts:424](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L424) +[settings/CSpellSettingsDef.ts:444](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L444) ___ @@ -159,4 +159,4 @@ Use Compounds #### Defined in -[settings/CSpellSettingsDef.ts:336](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L336) +[settings/CSpellSettingsDef.ts:356](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L356) diff --git a/docs/types/cspell-types/interfaces/DictionaryDefinitionPreferred.md b/docs/types/cspell-types/interfaces/DictionaryDefinitionPreferred.md index 6f667017ac9..71d379d8c0e 100644 --- a/docs/types/cspell-types/interfaces/DictionaryDefinitionPreferred.md +++ b/docs/types/cspell-types/interfaces/DictionaryDefinitionPreferred.md @@ -35,7 +35,7 @@ Optional description #### Defined in -[settings/CSpellSettingsDef.ts:332](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L332) +[settings/CSpellSettingsDef.ts:352](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L352) ___ @@ -58,7 +58,7 @@ Name Format: #### Defined in -[settings/CSpellSettingsDef.ts:330](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L330) +[settings/CSpellSettingsDef.ts:350](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L350) ___ @@ -80,7 +80,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:346](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L346) +[settings/CSpellSettingsDef.ts:366](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L366) ___ @@ -92,7 +92,7 @@ Path to the file #### Defined in -[settings/CSpellSettingsDef.ts:351](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L351) +[settings/CSpellSettingsDef.ts:371](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L371) ___ @@ -108,7 +108,7 @@ Replacement pairs #### Defined in -[settings/CSpellSettingsDef.ts:334](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L334) +[settings/CSpellSettingsDef.ts:354](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L354) ___ @@ -124,4 +124,4 @@ Use Compounds #### Defined in -[settings/CSpellSettingsDef.ts:336](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L336) +[settings/CSpellSettingsDef.ts:356](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L356) diff --git a/docs/types/cspell-types/interfaces/ExtendableSettings.md b/docs/types/cspell-types/interfaces/ExtendableSettings.md index b95447f20d0..05949ff804b 100644 --- a/docs/types/cspell-types/interfaces/ExtendableSettings.md +++ b/docs/types/cspell-types/interfaces/ExtendableSettings.md @@ -39,6 +39,8 @@ - [overrides](ExtendableSettings.md#overrides) - [patterns](ExtendableSettings.md#patterns) - [pnpFiles](ExtendableSettings.md#pnpfiles) +- [suggestionNumChanges](ExtendableSettings.md#suggestionnumchanges) +- [suggestionsTimeout](ExtendableSettings.md#suggestionstimeout) - [usePnP](ExtendableSettings.md#usepnp) - [words](ExtendableSettings.md#words) @@ -58,7 +60,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -76,7 +78,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -92,7 +94,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -111,7 +113,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -127,7 +129,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -159,7 +161,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -177,7 +179,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -193,7 +195,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -209,7 +211,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -225,7 +227,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -243,7 +245,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -259,7 +261,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -276,7 +278,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -298,7 +300,7 @@ Example: "en,nl" to enable both English and Dutch #### Defined in -[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) +[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) ___ @@ -314,7 +316,7 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid #### Defined in -[settings/CSpellSettingsDef.ts:149](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L149) +[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) ___ @@ -330,7 +332,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -348,7 +350,7 @@ The maximum number of times the same word can be flagged as an error in a file. #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -366,7 +368,7 @@ The maximum number of problems to report in a file. #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -384,7 +386,7 @@ The minimum length of a word before checking it against a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -400,7 +402,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -422,7 +424,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -440,7 +442,7 @@ Number of suggestions to make #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -452,7 +454,7 @@ Overrides to apply based upon the file path. #### Defined in -[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) +[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) ___ @@ -468,7 +470,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -486,7 +488,47 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[Settings](Settings.md).[suggestionNumChanges](Settings.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[Settings](Settings.md).[suggestionsTimeout](Settings.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -508,7 +550,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -524,4 +566,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/FileSettings.md b/docs/types/cspell-types/interfaces/FileSettings.md index 4fca8a8632c..63d9b407287 100644 --- a/docs/types/cspell-types/interfaces/FileSettings.md +++ b/docs/types/cspell-types/interfaces/FileSettings.md @@ -45,6 +45,8 @@ - [patterns](FileSettings.md#patterns) - [pnpFiles](FileSettings.md#pnpfiles) - [readonly](FileSettings.md#readonly) +- [suggestionNumChanges](FileSettings.md#suggestionnumchanges) +- [suggestionsTimeout](FileSettings.md#suggestionstimeout) - [usePnP](FileSettings.md#usepnp) - [userWords](FileSettings.md#userwords) - [version](FileSettings.md#version) @@ -66,7 +68,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -84,7 +86,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -100,7 +102,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -119,7 +121,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -135,7 +137,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -167,7 +169,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -185,7 +187,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -201,7 +203,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -214,7 +216,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) +[settings/CSpellSettingsDef.ts:61](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L61) ___ @@ -230,7 +232,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -253,7 +255,7 @@ Special Values: #### Defined in -[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) +[settings/CSpellSettingsDef.ts:55](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L55) ___ @@ -269,7 +271,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -282,7 +284,7 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi #### Defined in -[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) +[settings/CSpellSettingsDef.ts:67](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L67) ___ @@ -300,7 +302,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -316,7 +318,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -328,7 +330,7 @@ Other settings files to be included #### Defined in -[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) +[settings/CSpellSettingsDef.ts:38](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L38) ___ @@ -345,7 +347,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -367,7 +369,7 @@ Example: "en,nl" to enable both English and Dutch #### Defined in -[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) +[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) ___ @@ -383,7 +385,7 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid #### Defined in -[settings/CSpellSettingsDef.ts:149](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L149) +[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) ___ @@ -399,7 +401,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -417,7 +419,7 @@ The maximum number of times the same word can be flagged as an error in a file. #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -435,7 +437,7 @@ The maximum number of problems to report in a file. #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -453,7 +455,7 @@ The minimum length of a word before checking it against a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -469,7 +471,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -483,7 +485,7 @@ Prevents searching for local configuration when checking individual documents. #### Defined in -[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) +[settings/CSpellSettingsDef.ts:73](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L73) ___ @@ -505,7 +507,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -523,7 +525,7 @@ Number of suggestions to make #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -539,7 +541,7 @@ Overrides to apply based upon the file path. #### Defined in -[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) +[settings/CSpellSettingsDef.ts:86](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L86) ___ @@ -555,7 +557,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -573,7 +575,7 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) ___ @@ -589,7 +591,47 @@ modifying the file to add words and other configuration. #### Defined in -[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) +[settings/CSpellSettingsDef.ts:81](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L81) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[ExtendableSettings](ExtendableSettings.md).[suggestionNumChanges](ExtendableSettings.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[ExtendableSettings](ExtendableSettings.md).[suggestionsTimeout](ExtendableSettings.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -611,7 +653,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -623,7 +665,7 @@ Words to add to global dictionary -- should only be in the user config file. #### Defined in -[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) +[settings/CSpellSettingsDef.ts:35](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L35) ___ @@ -637,7 +679,7 @@ Configuration format version of the settings file. #### Defined in -[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) +[settings/CSpellSettingsDef.ts:32](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L32) ___ @@ -653,4 +695,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/FileSource.md b/docs/types/cspell-types/interfaces/FileSource.md index 9b542541b37..1a7a9b0ad9a 100644 --- a/docs/types/cspell-types/interfaces/FileSource.md +++ b/docs/types/cspell-types/interfaces/FileSource.md @@ -31,7 +31,7 @@ BaseSource.fileSource #### Defined in -[settings/CSpellSettingsDef.ts:658](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L658) +[settings/CSpellSettingsDef.ts:676](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L676) ___ @@ -47,7 +47,7 @@ BaseSource.filename #### Defined in -[settings/CSpellSettingsDef.ts:654](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L654) +[settings/CSpellSettingsDef.ts:672](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L672) ___ @@ -63,7 +63,7 @@ BaseSource.name #### Defined in -[settings/CSpellSettingsDef.ts:652](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L652) +[settings/CSpellSettingsDef.ts:670](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L670) ___ @@ -79,4 +79,4 @@ BaseSource.sources #### Defined in -[settings/CSpellSettingsDef.ts:656](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L656) +[settings/CSpellSettingsDef.ts:674](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L674) diff --git a/docs/types/cspell-types/interfaces/ImportFileRef.md b/docs/types/cspell-types/interfaces/ImportFileRef.md index bd6f78025b1..ff1a3462bd0 100644 --- a/docs/types/cspell-types/interfaces/ImportFileRef.md +++ b/docs/types/cspell-types/interfaces/ImportFileRef.md @@ -18,7 +18,7 @@ #### Defined in -[settings/CSpellSettingsDef.ts:17](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L17) +[settings/CSpellSettingsDef.ts:17](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L17) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:16](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L16) +[settings/CSpellSettingsDef.ts:16](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L16) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:18](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L18) +[settings/CSpellSettingsDef.ts:18](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L18) diff --git a/docs/types/cspell-types/interfaces/InMemorySource.md b/docs/types/cspell-types/interfaces/InMemorySource.md index 33f3d0a8ea0..871e377bca0 100644 --- a/docs/types/cspell-types/interfaces/InMemorySource.md +++ b/docs/types/cspell-types/interfaces/InMemorySource.md @@ -31,7 +31,7 @@ BaseSource.fileSource #### Defined in -[settings/CSpellSettingsDef.ts:680](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L680) +[settings/CSpellSettingsDef.ts:698](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L698) ___ @@ -47,7 +47,7 @@ BaseSource.filename #### Defined in -[settings/CSpellSettingsDef.ts:676](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L676) +[settings/CSpellSettingsDef.ts:694](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L694) ___ @@ -63,7 +63,7 @@ BaseSource.name #### Defined in -[settings/CSpellSettingsDef.ts:674](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L674) +[settings/CSpellSettingsDef.ts:692](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L692) ___ @@ -79,4 +79,4 @@ BaseSource.sources #### Defined in -[settings/CSpellSettingsDef.ts:678](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L678) +[settings/CSpellSettingsDef.ts:696](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L696) diff --git a/docs/types/cspell-types/interfaces/LanguageSetting.md b/docs/types/cspell-types/interfaces/LanguageSetting.md index e7b10a59975..4deacde595e 100644 --- a/docs/types/cspell-types/interfaces/LanguageSetting.md +++ b/docs/types/cspell-types/interfaces/LanguageSetting.md @@ -49,7 +49,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -67,7 +67,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -83,7 +83,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -102,7 +102,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -118,7 +118,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -136,7 +136,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -152,7 +152,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -168,7 +168,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -186,7 +186,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -202,7 +202,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -219,7 +219,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -235,7 +235,7 @@ The language id. Ex: "typescript", "html", or "php". "*" -- will match all lan #### Defined in -[settings/CSpellSettingsDef.ts:440](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L440) +[settings/CSpellSettingsDef.ts:460](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L460) ___ @@ -255,7 +255,7 @@ Deprecated - The locale filter, matches against the language. This can be a comm #### Defined in -[settings/CSpellSettingsDef.ts:453](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L453) +[settings/CSpellSettingsDef.ts:473](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L473) ___ @@ -271,7 +271,7 @@ The locale filter, matches against the language. This can be a comma separated l #### Defined in -[settings/CSpellSettingsDef.ts:442](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L442) +[settings/CSpellSettingsDef.ts:462](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L462) ___ @@ -287,7 +287,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -309,7 +309,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -325,7 +325,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -341,4 +341,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/LanguageSettingFilterFields.md b/docs/types/cspell-types/interfaces/LanguageSettingFilterFields.md index e45c515fce9..345e44af1fa 100644 --- a/docs/types/cspell-types/interfaces/LanguageSettingFilterFields.md +++ b/docs/types/cspell-types/interfaces/LanguageSettingFilterFields.md @@ -34,7 +34,7 @@ The language id. Ex: "typescript", "html", or "php". "*" -- will match all lan #### Defined in -[settings/CSpellSettingsDef.ts:440](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L440) +[settings/CSpellSettingsDef.ts:460](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L460) ___ @@ -54,7 +54,7 @@ Deprecated - The locale filter, matches against the language. This can be a comm #### Defined in -[settings/CSpellSettingsDef.ts:453](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L453) +[settings/CSpellSettingsDef.ts:473](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L473) ___ @@ -70,4 +70,4 @@ The locale filter, matches against the language. This can be a comma separated l #### Defined in -[settings/CSpellSettingsDef.ts:442](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L442) +[settings/CSpellSettingsDef.ts:462](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L462) diff --git a/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsDeprecated.md b/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsDeprecated.md index 3224b196617..93b1cefe987 100644 --- a/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsDeprecated.md +++ b/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsDeprecated.md @@ -25,7 +25,7 @@ The language id. Ex: "typescript", "html", or "php". "*" -- will match all lan #### Defined in -[settings/CSpellSettingsDef.ts:447](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L447) +[settings/CSpellSettingsDef.ts:467](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L467) ___ @@ -41,4 +41,4 @@ Deprecated - The locale filter, matches against the language. This can be a comm #### Defined in -[settings/CSpellSettingsDef.ts:453](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L453) +[settings/CSpellSettingsDef.ts:473](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L473) diff --git a/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsPreferred.md b/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsPreferred.md index 0826fd638c7..8a3f1fe5020 100644 --- a/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsPreferred.md +++ b/docs/types/cspell-types/interfaces/LanguageSettingFilterFieldsPreferred.md @@ -25,7 +25,7 @@ The language id. Ex: "typescript", "html", or "php". "*" -- will match all lan #### Defined in -[settings/CSpellSettingsDef.ts:440](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L440) +[settings/CSpellSettingsDef.ts:460](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L460) ___ @@ -37,4 +37,4 @@ The locale filter, matches against the language. This can be a comma separated l #### Defined in -[settings/CSpellSettingsDef.ts:442](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L442) +[settings/CSpellSettingsDef.ts:462](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L462) diff --git a/docs/types/cspell-types/interfaces/LegacySettings.md b/docs/types/cspell-types/interfaces/LegacySettings.md index ebae3797836..34329dc0d1d 100644 --- a/docs/types/cspell-types/interfaces/LegacySettings.md +++ b/docs/types/cspell-types/interfaces/LegacySettings.md @@ -32,7 +32,7 @@ Show status #### Defined in -[settings/CSpellSettingsDef.ts:212](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L212) +[settings/CSpellSettingsDef.ts:232](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L232) ___ @@ -46,4 +46,4 @@ Delay in ms after a document has changed before checking it for spelling errors. #### Defined in -[settings/CSpellSettingsDef.ts:218](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L218) +[settings/CSpellSettingsDef.ts:238](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L238) diff --git a/docs/types/cspell-types/interfaces/MergeSource.md b/docs/types/cspell-types/interfaces/MergeSource.md index 2d61e5ec3ca..088b2954da4 100644 --- a/docs/types/cspell-types/interfaces/MergeSource.md +++ b/docs/types/cspell-types/interfaces/MergeSource.md @@ -31,7 +31,7 @@ BaseSource.fileSource #### Defined in -[settings/CSpellSettingsDef.ts:669](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L669) +[settings/CSpellSettingsDef.ts:687](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L687) ___ @@ -47,7 +47,7 @@ BaseSource.filename #### Defined in -[settings/CSpellSettingsDef.ts:665](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L665) +[settings/CSpellSettingsDef.ts:683](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L683) ___ @@ -63,7 +63,7 @@ BaseSource.name #### Defined in -[settings/CSpellSettingsDef.ts:663](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L663) +[settings/CSpellSettingsDef.ts:681](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L681) ___ @@ -79,4 +79,4 @@ BaseSource.sources #### Defined in -[settings/CSpellSettingsDef.ts:667](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L667) +[settings/CSpellSettingsDef.ts:685](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L685) diff --git a/docs/types/cspell-types/interfaces/OverrideFilterFields.md b/docs/types/cspell-types/interfaces/OverrideFilterFields.md index a696697ac0b..438d985fecb 100644 --- a/docs/types/cspell-types/interfaces/OverrideFilterFields.md +++ b/docs/types/cspell-types/interfaces/OverrideFilterFields.md @@ -24,4 +24,4 @@ Glob pattern or patterns to match against #### Defined in -[settings/CSpellSettingsDef.ts:232](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L232) +[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) diff --git a/docs/types/cspell-types/interfaces/OverrideSettings.md b/docs/types/cspell-types/interfaces/OverrideSettings.md index 8c712e67bf4..7db46f46752 100644 --- a/docs/types/cspell-types/interfaces/OverrideSettings.md +++ b/docs/types/cspell-types/interfaces/OverrideSettings.md @@ -39,6 +39,8 @@ - [numSuggestions](OverrideSettings.md#numsuggestions) - [patterns](OverrideSettings.md#patterns) - [pnpFiles](OverrideSettings.md#pnpfiles) +- [suggestionNumChanges](OverrideSettings.md#suggestionnumchanges) +- [suggestionsTimeout](OverrideSettings.md#suggestionstimeout) - [usePnP](OverrideSettings.md#usepnp) - [words](OverrideSettings.md#words) @@ -58,7 +60,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -76,7 +78,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -92,7 +94,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -111,7 +113,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -127,7 +129,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -159,7 +161,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -177,7 +179,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -193,7 +195,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -209,7 +211,7 @@ Glob pattern or patterns to match against #### Defined in -[settings/CSpellSettingsDef.ts:232](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L232) +[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) ___ @@ -225,7 +227,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -241,7 +243,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -259,7 +261,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -275,7 +277,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -292,7 +294,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -308,7 +310,7 @@ Sets the locale #### Defined in -[settings/CSpellSettingsDef.ts:227](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L227) +[settings/CSpellSettingsDef.ts:247](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L247) ___ @@ -324,7 +326,7 @@ Sets the programming language id #### Defined in -[settings/CSpellSettingsDef.ts:224](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L224) +[settings/CSpellSettingsDef.ts:244](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L244) ___ @@ -340,7 +342,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -358,7 +360,7 @@ The maximum number of times the same word can be flagged as an error in a file. #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -376,7 +378,7 @@ The maximum number of problems to report in a file. #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -394,7 +396,7 @@ The minimum length of a word before checking it against a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -410,7 +412,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -432,7 +434,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -450,7 +452,7 @@ Number of suggestions to make #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -466,7 +468,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -484,7 +486,47 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[Settings](Settings.md).[suggestionNumChanges](Settings.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[Settings](Settings.md).[suggestionsTimeout](Settings.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -506,7 +548,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -522,4 +564,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/PnPSettings.md b/docs/types/cspell-types/interfaces/PnPSettings.md index 9b4e7e548da..d0c581ab249 100644 --- a/docs/types/cspell-types/interfaces/PnPSettings.md +++ b/docs/types/cspell-types/interfaces/PnPSettings.md @@ -29,7 +29,7 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) ___ @@ -47,4 +47,4 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) diff --git a/docs/types/cspell-types/interfaces/RegExpPatternDefinition.md b/docs/types/cspell-types/interfaces/RegExpPatternDefinition.md index cc557863c0f..a43df7dbbc9 100644 --- a/docs/types/cspell-types/interfaces/RegExpPatternDefinition.md +++ b/docs/types/cspell-types/interfaces/RegExpPatternDefinition.md @@ -20,7 +20,7 @@ Description of the pattern. #### Defined in -[settings/CSpellSettingsDef.ts:642](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L642) +[settings/CSpellSettingsDef.ts:660](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L660) ___ @@ -33,7 +33,7 @@ It is possible to redefine one of the predefined patterns to override its value. #### Defined in -[settings/CSpellSettingsDef.ts:634](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L634) +[settings/CSpellSettingsDef.ts:652](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L652) ___ @@ -45,4 +45,4 @@ RegExp pattern or array of RegExp patterns #### Defined in -[settings/CSpellSettingsDef.ts:638](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L638) +[settings/CSpellSettingsDef.ts:656](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L656) diff --git a/docs/types/cspell-types/interfaces/ReportingConfiguration.md b/docs/types/cspell-types/interfaces/ReportingConfiguration.md new file mode 100644 index 00000000000..4833cc3eaf9 --- /dev/null +++ b/docs/types/cspell-types/interfaces/ReportingConfiguration.md @@ -0,0 +1,122 @@ +[@cspell/cspell-types](../README.md) / [Exports](../modules.md) / ReportingConfiguration + +# Interface: ReportingConfiguration + +## Hierarchy + +- [`SuggestionsConfiguration`](SuggestionsConfiguration.md) + + ↳ **`ReportingConfiguration`** + + ↳↳ [`Settings`](Settings.md) + +## Table of contents + +### Properties + +- [maxDuplicateProblems](ReportingConfiguration.md#maxduplicateproblems) +- [maxNumberOfProblems](ReportingConfiguration.md#maxnumberofproblems) +- [minWordLength](ReportingConfiguration.md#minwordlength) +- [numSuggestions](ReportingConfiguration.md#numsuggestions) +- [suggestionNumChanges](ReportingConfiguration.md#suggestionnumchanges) +- [suggestionsTimeout](ReportingConfiguration.md#suggestionstimeout) + +## Properties + +### maxDuplicateProblems + +• `Optional` **maxDuplicateProblems**: `number` + +The maximum number of times the same word can be flagged as an error in a file. + +**`default`** 5 + +#### Defined in + +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) + +___ + +### maxNumberOfProblems + +• `Optional` **maxNumberOfProblems**: `number` + +The maximum number of problems to report in a file. + +**`default`** 100 + +#### Defined in + +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) + +___ + +### minWordLength + +• `Optional` **minWordLength**: `number` + +The minimum length of a word before checking it against a dictionary. + +**`default`** 4 + +#### Defined in + +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) + +___ + +### numSuggestions + +• `Optional` **numSuggestions**: `number` + +Number of suggestions to make + +**`default`** 10 + +#### Inherited from + +[SuggestionsConfiguration](SuggestionsConfiguration.md).[numSuggestions](SuggestionsConfiguration.md#numsuggestions) + +#### Defined in + +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[SuggestionsConfiguration](SuggestionsConfiguration.md).[suggestionNumChanges](SuggestionsConfiguration.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[SuggestionsConfiguration](SuggestionsConfiguration.md).[suggestionsTimeout](SuggestionsConfiguration.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) diff --git a/docs/types/cspell-types/interfaces/Settings.md b/docs/types/cspell-types/interfaces/Settings.md index d9d8b6a25a6..741a7e25a7b 100644 --- a/docs/types/cspell-types/interfaces/Settings.md +++ b/docs/types/cspell-types/interfaces/Settings.md @@ -4,6 +4,8 @@ ## Hierarchy +- [`ReportingConfiguration`](ReportingConfiguration.md) + - [`BaseSetting`](BaseSetting.md) - [`PnPSettings`](PnPSettings.md) @@ -42,6 +44,8 @@ - [numSuggestions](Settings.md#numsuggestions) - [patterns](Settings.md#patterns) - [pnpFiles](Settings.md#pnpfiles) +- [suggestionNumChanges](Settings.md#suggestionnumchanges) +- [suggestionsTimeout](Settings.md#suggestionstimeout) - [usePnP](Settings.md#usepnp) - [words](Settings.md#words) @@ -61,7 +65,7 @@ True to enable compound word checking. #### Defined in -[settings/CSpellSettingsDef.ts:264](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L264) +[settings/CSpellSettingsDef.ts:284](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L284) ___ @@ -79,7 +83,7 @@ Words must match case rules. #### Defined in -[settings/CSpellSettingsDef.ts:270](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L270) +[settings/CSpellSettingsDef.ts:290](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L290) ___ @@ -95,7 +99,7 @@ Optional description of configuration #### Defined in -[settings/CSpellSettingsDef.ts:243](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L243) +[settings/CSpellSettingsDef.ts:263](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L263) ___ @@ -114,7 +118,7 @@ i.e. `!typescript` will turn off the dictionary with the name `typescript`. #### Defined in -[settings/CSpellSettingsDef.ts:281](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L281) +[settings/CSpellSettingsDef.ts:301](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L301) ___ @@ -130,7 +134,7 @@ Define additional available dictionaries #### Defined in -[settings/CSpellSettingsDef.ts:273](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L273) +[settings/CSpellSettingsDef.ts:293](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L293) ___ @@ -158,7 +162,7 @@ kotlin // enable checking for kotlin #### Defined in -[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) +[settings/CSpellSettingsDef.ts:119](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L119) ___ @@ -176,7 +180,7 @@ Is the spell checker enabled #### Defined in -[settings/CSpellSettingsDef.ts:249](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L249) +[settings/CSpellSettingsDef.ts:269](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L269) ___ @@ -188,7 +192,7 @@ languageIds for the files to spell check. #### Defined in -[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) +[settings/CSpellSettingsDef.ts:101](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L101) ___ @@ -204,7 +208,7 @@ list of words to always be considered incorrect. #### Defined in -[settings/CSpellSettingsDef.ts:255](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L255) +[settings/CSpellSettingsDef.ts:275](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L275) ___ @@ -220,7 +224,7 @@ Optional identifier #### Defined in -[settings/CSpellSettingsDef.ts:237](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L237) +[settings/CSpellSettingsDef.ts:257](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L257) ___ @@ -238,7 +242,7 @@ Example: ["href"] - to exclude html href #### Defined in -[settings/CSpellSettingsDef.ts:299](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L299) +[settings/CSpellSettingsDef.ts:319](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L319) ___ @@ -254,7 +258,7 @@ List of words to be ignored. An Ignored word will not show up as an error even i #### Defined in -[settings/CSpellSettingsDef.ts:258](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L258) +[settings/CSpellSettingsDef.ts:278](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L278) ___ @@ -271,7 +275,7 @@ If includeRegExpList is defined, ONLY, text matching the included patterns will #### Defined in -[settings/CSpellSettingsDef.ts:305](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L305) +[settings/CSpellSettingsDef.ts:325](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L325) ___ @@ -289,7 +293,7 @@ Example: "en,nl" to enable both English and Dutch #### Defined in -[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) +[settings/CSpellSettingsDef.ts:98](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L98) ___ @@ -301,7 +305,7 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid #### Defined in -[settings/CSpellSettingsDef.ts:149](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L149) +[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) ___ @@ -313,7 +317,7 @@ Additional settings for individual languages. #### Defined in -[settings/CSpellSettingsDef.ts:146](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L146) +[settings/CSpellSettingsDef.ts:122](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L122) ___ @@ -325,9 +329,13 @@ The maximum number of times the same word can be flagged as an error in a file. **`default`** 5 +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[maxDuplicateProblems](ReportingConfiguration.md#maxduplicateproblems) + #### Defined in -[settings/CSpellSettingsDef.ts:131](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L131) +[settings/CSpellSettingsDef.ts:139](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L139) ___ @@ -339,9 +347,13 @@ The maximum number of problems to report in a file. **`default`** 100 +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[maxNumberOfProblems](ReportingConfiguration.md#maxnumberofproblems) + #### Defined in -[settings/CSpellSettingsDef.ts:125](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L125) +[settings/CSpellSettingsDef.ts:133](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L133) ___ @@ -353,9 +365,13 @@ The minimum length of a word before checking it against a dictionary. **`default`** 4 +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[minWordLength](ReportingConfiguration.md#minwordlength) + #### Defined in -[settings/CSpellSettingsDef.ts:137](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L137) +[settings/CSpellSettingsDef.ts:145](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L145) ___ @@ -371,7 +387,7 @@ Optional name of configuration #### Defined in -[settings/CSpellSettingsDef.ts:240](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L240) +[settings/CSpellSettingsDef.ts:260](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L260) ___ @@ -393,7 +409,7 @@ possible suggestions. #### Defined in -[settings/CSpellSettingsDef.ts:292](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L292) +[settings/CSpellSettingsDef.ts:312](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L312) ___ @@ -405,9 +421,13 @@ Number of suggestions to make **`default`** 10 +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[numSuggestions](ReportingConfiguration.md#numsuggestions) + #### Defined in -[settings/CSpellSettingsDef.ts:143](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L143) +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) ___ @@ -423,7 +443,7 @@ Defines a list of patterns that can be used in ignoreRegExpList and includeRegEx #### Defined in -[settings/CSpellSettingsDef.ts:308](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L308) +[settings/CSpellSettingsDef.ts:328](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L328) ___ @@ -441,7 +461,47 @@ The PnP files to search for. Note: `.mjs` files are not currently supported. #### Defined in -[settings/CSpellSettingsDef.ts:172](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L172) +[settings/CSpellSettingsDef.ts:192](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L192) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[suggestionNumChanges](ReportingConfiguration.md#suggestionnumchanges) + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Inherited from + +[ReportingConfiguration](ReportingConfiguration.md).[suggestionsTimeout](ReportingConfiguration.md#suggestionstimeout) + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) ___ @@ -463,7 +523,7 @@ of a PnP file and load it. #### Defined in -[settings/CSpellSettingsDef.ts:165](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L165) +[settings/CSpellSettingsDef.ts:185](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L185) ___ @@ -479,4 +539,4 @@ list of words to be always considered correct #### Defined in -[settings/CSpellSettingsDef.ts:252](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L252) +[settings/CSpellSettingsDef.ts:272](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L272) diff --git a/docs/types/cspell-types/interfaces/SuggestionsConfiguration.md b/docs/types/cspell-types/interfaces/SuggestionsConfiguration.md new file mode 100644 index 00000000000..b156b146202 --- /dev/null +++ b/docs/types/cspell-types/interfaces/SuggestionsConfiguration.md @@ -0,0 +1,63 @@ +[@cspell/cspell-types](../README.md) / [Exports](../modules.md) / SuggestionsConfiguration + +# Interface: SuggestionsConfiguration + +## Hierarchy + +- **`SuggestionsConfiguration`** + + ↳ [`ReportingConfiguration`](ReportingConfiguration.md) + +## Table of contents + +### Properties + +- [numSuggestions](SuggestionsConfiguration.md#numsuggestions) +- [suggestionNumChanges](SuggestionsConfiguration.md#suggestionnumchanges) +- [suggestionsTimeout](SuggestionsConfiguration.md#suggestionstimeout) + +## Properties + +### numSuggestions + +• `Optional` **numSuggestions**: `number` + +Number of suggestions to make + +**`default`** 10 + +#### Defined in + +[settings/CSpellSettingsDef.ts:153](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L153) + +___ + +### suggestionNumChanges + +• `Optional` **suggestionNumChanges**: `number` + +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. + +**`default`** 3 + +#### Defined in + +[settings/CSpellSettingsDef.ts:169](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L169) + +___ + +### suggestionsTimeout + +• `Optional` **suggestionsTimeout**: `number` + +The maximum amount of time in milliseconds to generate suggestions for a word. + +**`default`** 500 + +#### Defined in + +[settings/CSpellSettingsDef.ts:159](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L159) diff --git a/docs/types/cspell-types/interfaces/WorkspaceTrustSettings.md b/docs/types/cspell-types/interfaces/WorkspaceTrustSettings.md index 5cb80f9aff6..a5eb370d80e 100644 --- a/docs/types/cspell-types/interfaces/WorkspaceTrustSettings.md +++ b/docs/types/cspell-types/interfaces/WorkspaceTrustSettings.md @@ -30,7 +30,7 @@ Sets the default trust level #### Defined in -[settings/CSpellSettingsDef.ts:199](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L199) +[settings/CSpellSettingsDef.ts:219](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L219) ___ @@ -42,7 +42,7 @@ Glob patterns of locations that contain ALWAYS trusted files #### Defined in -[settings/CSpellSettingsDef.ts:188](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L188) +[settings/CSpellSettingsDef.ts:208](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L208) ___ @@ -54,4 +54,4 @@ Glob patterns of locations that contain NEVER trusted files #### Defined in -[settings/CSpellSettingsDef.ts:193](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L193) +[settings/CSpellSettingsDef.ts:213](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L213) diff --git a/docs/types/cspell-types/modules.md b/docs/types/cspell-types/modules.md index e399ccf880e..a4b77bbc2c1 100644 --- a/docs/types/cspell-types/modules.md +++ b/docs/types/cspell-types/modules.md @@ -28,7 +28,9 @@ - [OverrideSettings](interfaces/OverrideSettings.md) - [PnPSettings](interfaces/PnPSettings.md) - [RegExpPatternDefinition](interfaces/RegExpPatternDefinition.md) +- [ReportingConfiguration](interfaces/ReportingConfiguration.md) - [Settings](interfaces/Settings.md) +- [SuggestionsConfiguration](interfaces/SuggestionsConfiguration.md) - [WorkspaceTrustSettings](interfaces/WorkspaceTrustSettings.md) ### Type aliases @@ -77,7 +79,7 @@ These settings come from user and workspace settings. #### Defined in -[settings/CSpellSettingsDef.ts:7](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L7) +[settings/CSpellSettingsDef.ts:7](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L7) ___ @@ -87,7 +89,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:9](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L9) +[settings/CSpellSettingsDef.ts:9](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L9) ___ @@ -97,7 +99,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:645](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L645) +[settings/CSpellSettingsDef.ts:663](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L663) ___ @@ -111,7 +113,7 @@ A File System Path to a dictionary file. #### Defined in -[settings/CSpellSettingsDef.ts:627](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L627) +[settings/CSpellSettingsDef.ts:645](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L645) ___ @@ -123,7 +125,7 @@ Specifies the scope of a dictionary. #### Defined in -[settings/CSpellSettingsDef.ts:407](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L407) +[settings/CSpellSettingsDef.ts:427](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L427) ___ @@ -133,7 +135,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:313](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L313) +[settings/CSpellSettingsDef.ts:333](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L333) ___ @@ -143,7 +145,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:311](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L311) +[settings/CSpellSettingsDef.ts:331](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L331) ___ @@ -164,7 +166,7 @@ Name Format: #### Defined in -[settings/CSpellSettingsDef.ts:508](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L508) +[settings/CSpellSettingsDef.ts:528](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L528) ___ @@ -187,7 +189,7 @@ The reference starts with 1 or more `!`. #### Defined in -[settings/CSpellSettingsDef.ts:532](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L532) +[settings/CSpellSettingsDef.ts:550](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L550) ___ @@ -201,7 +203,7 @@ A File System Path to a dictionary file. #### Defined in -[settings/CSpellSettingsDef.ts:621](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L621) +[settings/CSpellSettingsDef.ts:639](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L639) ___ @@ -212,11 +214,9 @@ ___ This a reference to a named dictionary. It is expected to match the name of a dictionary. -**`pattern`** ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$ - #### Defined in -[settings/CSpellSettingsDef.ts:516](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L516) +[settings/CSpellSettingsDef.ts:534](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L534) ___ @@ -231,7 +231,7 @@ One of: #### Defined in -[settings/CSpellSettingsDef.ts:540](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L540) +[settings/CSpellSettingsDef.ts:558](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L558) ___ @@ -243,7 +243,7 @@ A File System Path #### Defined in -[settings/CSpellSettingsDef.ts:612](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L612) +[settings/CSpellSettingsDef.ts:630](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L630) ___ @@ -255,7 +255,7 @@ These are glob expressions #### Defined in -[settings/CSpellSettingsDef.ts:566](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L566) +[settings/CSpellSettingsDef.ts:584](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L584) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:609](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L609) +[settings/CSpellSettingsDef.ts:627](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L627) ___ @@ -279,7 +279,7 @@ This can be 'typescript,cpp,json,literal haskell', etc. #### Defined in -[settings/CSpellSettingsDef.ts:601](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L601) +[settings/CSpellSettingsDef.ts:619](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L619) ___ @@ -293,7 +293,7 @@ This can be 'typescript,cpp,json,literal haskell', etc. #### Defined in -[settings/CSpellSettingsDef.ts:607](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L607) +[settings/CSpellSettingsDef.ts:625](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L625) ___ @@ -307,7 +307,7 @@ This can be '*', 'typescript', 'cpp', 'json', etc. #### Defined in -[settings/CSpellSettingsDef.ts:595](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L595) +[settings/CSpellSettingsDef.ts:613](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L613) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:563](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L563) +[settings/CSpellSettingsDef.ts:581](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L581) ___ @@ -333,7 +333,7 @@ This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. #### Defined in -[settings/CSpellSettingsDef.ts:543](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L543) +[settings/CSpellSettingsDef.ts:561](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L561) ___ @@ -343,7 +343,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:459](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L459) +[settings/CSpellSettingsDef.ts:479](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L479) ___ @@ -355,7 +355,7 @@ This matches the name in a pattern definition #### Defined in -[settings/CSpellSettingsDef.ts:488](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L488) +[settings/CSpellSettingsDef.ts:508](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L508) ___ @@ -367,7 +367,7 @@ A PatternRef is a Pattern or PatternId. #### Defined in -[settings/CSpellSettingsDef.ts:491](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L491) +[settings/CSpellSettingsDef.ts:511](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L511) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:461](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L461) +[settings/CSpellSettingsDef.ts:481](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L481) ___ @@ -389,7 +389,7 @@ A list of pattern names or regular expressions #### Defined in -[settings/CSpellSettingsDef.ts:494](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L494) +[settings/CSpellSettingsDef.ts:514](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L514) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:1](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L1) +[settings/CSpellSettingsDef.ts:1](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L1) ___ @@ -409,7 +409,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:2](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L2) +[settings/CSpellSettingsDef.ts:2](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L2) ___ @@ -421,7 +421,7 @@ Simple Glob string, the root will be globRoot #### Defined in -[settings/CSpellSettingsDef.ts:569](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L569) +[settings/CSpellSettingsDef.ts:587](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L587) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:648](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L648) +[settings/CSpellSettingsDef.ts:666](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L666) ___ @@ -443,7 +443,7 @@ Trust Security Level #### Defined in -[settings/CSpellSettingsDef.ts:615](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L615) +[settings/CSpellSettingsDef.ts:633](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L633) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -[settings/CSpellSettingsDef.ts:557](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L557) +[settings/CSpellSettingsDef.ts:575](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L575) ___ @@ -465,7 +465,7 @@ Configuration File Version #### Defined in -[settings/CSpellSettingsDef.ts:548](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L548) +[settings/CSpellSettingsDef.ts:566](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L566) ___ @@ -481,4 +481,4 @@ Legacy Configuration File Versions #### Defined in -[settings/CSpellSettingsDef.ts:555](https://github.com/streetsidesoftware/cspell/blob/2d85fdee/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L555) +[settings/CSpellSettingsDef.ts:573](https://github.com/streetsidesoftware/cspell/blob/2bb6c82a/packages/cspell-types/src/settings/CSpellSettingsDef.ts#L573)