From b46f0e48f77f10fe2b8ce7c92944b0831f9d5e7a Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Fri, 14 Jun 2024 00:30:48 +0200 Subject: [PATCH 1/2] docs: change `
` indent in generated markdown --- website/_scripts/extract-properties.mjs | 16 +- .../_category_.yaml | 0 website/docs/Configuration/auto_properties.md | 9194 +++++++++-------- 3 files changed, 5095 insertions(+), 4115 deletions(-) rename website/docs/{configuration => Configuration}/_category_.yaml (100%) diff --git a/website/_scripts/extract-properties.mjs b/website/_scripts/extract-properties.mjs index 8da8a68b0ce6..a88f99db3788 100644 --- a/website/_scripts/extract-properties.mjs +++ b/website/_scripts/extract-properties.mjs @@ -113,18 +113,22 @@ function formatTypeEntryBody(entry) { dlDescription = removeLeftPad(`
Description
- ${padLines(dlDescription, ' ')} + + ${padLines(dlDescription, ' ')} +
`); } return removeLeftPad(`
- ${padLines(dlDescription, ' ')} -
Type
-
- ${formatEntryType(entry)} -
+ ${padLines(dlDescription, ' ')} +
Type
+
+ + ${formatEntryType(entry)} + +
`); } diff --git a/website/docs/configuration/_category_.yaml b/website/docs/Configuration/_category_.yaml similarity index 100% rename from website/docs/configuration/_category_.yaml rename to website/docs/Configuration/_category_.yaml diff --git a/website/docs/Configuration/auto_properties.md b/website/docs/Configuration/auto_properties.md index 9036e9c1f155..696f3e19b61d 100644 --- a/website/docs/Configuration/auto_properties.md +++ b/website/docs/Configuration/auto_properties.md @@ -72,4217 +72,4987 @@ format: md #### `$schema` {#settings--schema}
- -
Description
-
- Url to JSON Schema -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `allowCompoundWords` {#settings-allowcompoundwords} +Url to JSON Schema -
- -
Description
-
- True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `cache` {#settings-cache} +`string` -
- -
Description
-
- Define cache settings. -
- -
Type
-
- [`CacheSettings`](#cachesettings) -
+
--- -#### `caseSensitive` {#settings-casesensitive} +#### `allowCompoundWords` {#settings-allowcompoundwords}
- -
Description
-
- Determines if words must match case and accent rules. - - - `false` - Case is ignored and accents can be missing on the entire word. - Incorrect accents or partially missing accents will be marked as incorrect. - - `true` - Case and accents are enforced. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `description` {#settings-description} +True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. -
- -
Description
-
- Optional description of configuration. -
- -
Type
-
- `string` -
-
+
---- +
Type
+
-#### `dictionaries` {#settings-dictionaries} +`boolean` -
- -
Description
-
- Optional list of dictionaries to use. Each entry should match the name of the dictionary. - - To remove a dictionary from the list, add `!` before the name. - - For example, `!typescript` will turn off the dictionary with the name `typescript`. - - See the [Dictionaries](https://cspell.org/docs/dictionaries/) - and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
+
--- -#### `dictionaryDefinitions` {#settings-dictionarydefinitions} +#### `cache` {#settings-cache}
- -
Description
-
- Define additional available dictionaries. - - For example, you can use the following to add a custom dictionary: - - ```json - "dictionaryDefinitions": [ - { "name": "custom-words", "path": "./custom-words.txt"} - ], - "dictionaries": ["custom-words"] - ``` -
- -
Type
-
- [`DictionaryDefinition`](#dictionarydefinition)`[]` -
-
---- +
Description
+
-#### `enableFiletypes` {#settings-enablefiletypes} +Define cache settings. -
- -
Description
-
- Enable / Disable checking file types (languageIds). - - These are in additional to the file types specified by [Settings.enabledLanguageIds](#settings-enabledlanguageids) . - To disable a language, prefix with `!` as in `!json`, - - - **Example: individual file types** - - ``` - jsonc // enable checking for jsonc - !json // disable checking for json - kotlin // enable checking for kotlin - ``` - - **Example: enable all file types** - - ``` - * // enable checking for all file types - !json // except for json - ``` -
- -
Type
-
- [`LanguageIdSingle`](#languageidsingle)`[]` -
-
+
---- +
Type
+
-#### `enableGlobDot` {#settings-enableglobdot} +[`CacheSettings`](#cachesettings) -
- -
Description
-
- Enable scanning files and directories beginning with `.` (period). - - By default, CSpell does not scan `hidden` files. -
- -
Type
-
- `boolean` -
+
--- -#### `enabled` {#settings-enabled} +#### `caseSensitive` {#settings-casesensitive}
- -
Description
-
- Is the spell checker enabled. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `enabledFileTypes` {#settings-enabledfiletypes} +Determines if words must match case and accent rules. -
- -
Description
-
- Enable / Disable checking file types (languageIds). - - This setting replaces: [Settings.enabledLanguageIds](#settings-enabledlanguageids) and [Settings.enableFiletypes](#settings-enablefiletypes) . - - A Value of: - - `true` - enable checking for the file type - - `false` - disable checking for the file type - - A file type of `*` is a wildcard that enables all file types. - - **Example: enable all file types** - - | File Type | Enabled | Comment | - | --------- | ------- | ------- | - | `*` | `true` | Enable all file types. | - | `json` | `false` | Disable checking for json files. | -
- -
Type
-
- `object` -
-
+- `false` - Case is ignored and accents can be missing on the entire word. + Incorrect accents or partially missing accents will be marked as incorrect. +- `true` - Case and accents are enforced. ---- +
-#### `enabledLanguageIds` {#settings-enabledlanguageids} +
Type
+
-
- -
Description
-
- Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. -
- -
Type
-
- [`LanguageIdSingle`](#languageidsingle)`[]` -
+`boolean` + +
--- -#### `failFast` {#settings-failfast} +#### `description` {#settings-description}
- -
Description
-
- Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks) -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `features` {#settings-features} +Optional description of configuration. -
- -
Description
-
- Configure CSpell features. -
- -
Type
-
- [`Features`](#features) -
-
+
---- +
Type
+
-#### `files` {#settings-files} +`string` -
- -
Description
-
- Glob patterns of files to be checked. - - Glob patterns are relative to the `globRoot` of the configuration file that defines them. -
- -
Type
-
- [`Glob`](#glob)`[]` -
+
--- -#### `flagWords` {#settings-flagwords} +#### `dictionaries` {#settings-dictionaries}
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
-
---- +
Description
+
-#### `gitignoreRoot` {#settings-gitignoreroot} +Optional list of dictionaries to use. Each entry should match the name of the dictionary. -
- -
Description
-
- Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. -
- -
Type
-
- [`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` -
-
+To remove a dictionary from the list, add `!` before the name. ---- +For example, `!typescript` will turn off the dictionary with the name `typescript`. -#### `globRoot` {#settings-globroot} +See the [Dictionaries](https://cspell.org/docs/dictionaries/) +and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. -
- -
Description
-
- The root to use for glob patterns found in this configuration. - Default: location of the configuration file. - For compatibility reasons, config files with version 0.1, the glob root will - default to be `${cwd}`. - - Use `globRoot` to define a different location. - `globRoot` can be relative to the location of this configuration file. - Defining globRoot, does not impact imported configurations. - - Special Values: - - `${cwd}` - will be replaced with the current working directory. - - `.` - will be the location of the containing configuration file. -
- -
Type
-
- [`FSPathResolvable`](#fspathresolvable) -
-
+
---- +
Type
+
-#### `id` {#settings-id} +[`DictionaryReference`](#dictionaryreference)`[]` -
- -
Description
-
- Optional identifier. -
- -
Type
-
- `string` -
+
--- -#### `ignorePaths` {#settings-ignorepaths} +#### `dictionaryDefinitions` {#settings-dictionarydefinitions}
- -
Description
-
- Glob patterns of files to be ignored. - - Glob patterns are relative to the `globRoot` of the configuration file that defines them. -
- -
Type
-
- [`Glob`](#glob)`[]` -
-
- ---- -#### `ignoreRegExpList` {#settings-ignoreregexplist} +
Description
+
-
- -
Description
-
- List of regular expression patterns or pattern names to exclude from spell checking. - - Example: `["href"]` - to exclude html href pattern. - - Regular expressions use JavaScript regular expression syntax. - - Example: to ignore ALL-CAPS words - - JSON - ```json - "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] - ``` - - YAML - ```yaml - ignoreRegExpList: - - >- - /\b[A-Z]+\b/g - ``` - - By default, several patterns are excluded. See - [Configuration](https://cspell.org/configuration/patterns) for more details. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
-
+Define additional available dictionaries. ---- +For example, you can use the following to add a custom dictionary: -#### `ignoreWords` {#settings-ignorewords} +```json +"dictionaryDefinitions": [ + { "name": "custom-words", "path": "./custom-words.txt"} +], +"dictionaries": ["custom-words"] +``` -
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
-
+
---- +
Type
+
-#### `import` {#settings-import} +[`DictionaryDefinition`](#dictionarydefinition)`[]` -
- -
Description
-
- Allows this configuration to inherit configuration for one or more other files. - - See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details. -
- -
Type
-
- [`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` -
+
--- -#### `includeRegExpList` {#settings-includeregexplist} +#### `enableFiletypes` {#settings-enablefiletypes}
- -
Description
-
- List of regular expression patterns or defined pattern names to match for spell checking. - - If this property is defined, only text matching the included patterns will be checked. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
-
---- +
Description
+
-#### `language` {#settings-language} +Enable / Disable checking file types (languageIds). -
- -
Description
-
- Current active spelling language. This specifies the language locale to use in choosing the - general dictionary. - - For example: - - - "en-GB" for British English. - - "en,nl" to enable both English and Dutch. -
- -
Type
-
- [`LocaleId`](#localeid) -
-
+These are in additional to the file types specified by [Settings.enabledLanguageIds](#settings-enabledlanguageids) . +To disable a language, prefix with `!` as in `!json`, ---- -#### `languageId` {#settings-languageid} +**Example: individual file types** -
- -
Description
-
- Forces the spell checker to assume a give language id. Used mainly as an Override. -
- -
Type
-
- [`MatchingFileType`](#matchingfiletype) -
-
+``` +jsonc // enable checking for jsonc +!json // disable checking for json +kotlin // enable checking for kotlin +``` ---- +**Example: enable all file types** -#### `languageSettings` {#settings-languagesettings} +``` +* // enable checking for all file types +!json // except for json +``` -
- -
Description
-
- Additional settings for individual languages. - - See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. -
- -
Type
-
- [`LanguageSetting`](#languagesetting)`[]` -
-
+
---- +
Type
+
-#### `loadDefaultConfiguration` {#settings-loaddefaultconfiguration} +[`LanguageIdSingle`](#languageidsingle)`[]` -
- -
Description
-
- By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` - will prevent ALL default configuration from being loaded. -
- -
Type
-
- `boolean` -
+
--- -#### `maxDuplicateProblems` {#settings-maxduplicateproblems} +#### `enableGlobDot` {#settings-enableglobdot}
- -
Description
-
- The maximum number of times the same word can be flagged as an error in a file. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `maxNumberOfProblems` {#settings-maxnumberofproblems} +Enable scanning files and directories beginning with `.` (period). -
- -
Description
-
- The maximum number of problems to report in a file. -
- -
Type
-
- `number` -
-
+By default, CSpell does not scan `hidden` files. ---- +
-#### `minWordLength` {#settings-minwordlength} +
Type
+
-
- -
Description
-
- The minimum length of a word before checking it against a dictionary. -
- -
Type
-
- `number` -
+`boolean` + +
--- -#### `name` {#settings-name} +#### `enabled` {#settings-enabled}
- -
Description
-
- Optional name of configuration. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `noConfigSearch` {#settings-noconfigsearch} +Is the spell checker enabled. -
- -
Description
-
- Prevents searching for local configuration when checking individual documents. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `noSuggestDictionaries` {#settings-nosuggestdictionaries} +`boolean` -
- -
Description
-
- Optional list of dictionaries that will not be used for suggestions. - Words in these dictionaries are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - one of these dictionaries, it will be removed from the set of - possible suggestions. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
+
--- -#### `numSuggestions` {#settings-numsuggestions} +#### `enabledFileTypes` {#settings-enabledfiletypes}
- -
Description
-
- Number of suggestions to make. -
- -
Type
-
- `number` -
-
---- - -#### `overrides` {#settings-overrides} +
Description
+
-
- -
Description
-
- Overrides are used to apply settings for specific files in your project. - - For example: - - ```javascript - "overrides": [ - // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: - { - "filename": "**/{*.hrr,*.crr}", - "languageId": "cpp" - }, - // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately): - { - "language": "nl", - "filename": "**/dutch/**/*.txt" - } - ] - ``` -
- -
Type
-
- [`OverrideSettings`](#overridesettings)`[]` -
-
+Enable / Disable checking file types (languageIds). ---- +This setting replaces: [Settings.enabledLanguageIds](#settings-enabledlanguageids) and [Settings.enableFiletypes](#settings-enablefiletypes) . -#### `patterns` {#settings-patterns} +A Value of: +- `true` - enable checking for the file type +- `false` - disable checking for the file type -
- -
Description
-
- Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. - - For example: - - ```javascript - "ignoreRegExpList": ["comments"], - "patterns": [ - { - "name": "comment-single-line", - "pattern": "/#.*/g" - }, - { - "name": "comment-multi-line", - "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" - }, - // You can also combine multiple named patterns into one single named pattern - { - "name": "comments", - "pattern": ["comment-single-line", "comment-multi-line"] - } - ] - ``` - Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. -
- -
Type
-
- [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` -
-
+A file type of `*` is a wildcard that enables all file types. ---- +**Example: enable all file types** -#### `pnpFiles` {#settings-pnpfiles} +| File Type | Enabled | Comment | +| --------- | ------- | ------- | +| `*` | `true` | Enable all file types. | +| `json` | `false` | Disable checking for json files. | -
- -
Description
-
- The PnP files to search for. Note: `.mjs` files are not currently supported. -
- -
Type
-
- `string``[]` -
-
+
---- +
Type
+
-#### `readonly` {#settings-readonly} +`object` -
- -
Description
-
- Indicate that the configuration file should not be modified. - This is used to prevent tools like the VS Code Spell Checker from - modifying the file to add words and other configuration. -
- -
Type
-
- `boolean` -
+
--- -#### `reporters` {#settings-reporters} +#### `enabledLanguageIds` {#settings-enabledlanguageids}
- -
Description
-
- Define which reports to use. - `default` - is a special name for the default cli reporter. - - Examples: - - `["default"]` - to use the default reporter - - `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter. - - `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - - `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter. -
- -
Type
-
- [`ReporterSettings`](#reportersettings)`[]` -
-
---- +
Description
+
-#### `showStatus` {#settings-showstatus} +Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. -
- -
Description
-
- Show status. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `spellCheckDelayMs` {#settings-spellcheckdelayms} +[`LanguageIdSingle`](#languageidsingle)`[]` -
- -
Description
-
- Delay in ms after a document has changed before checking it for spelling errors. -
- -
Type
-
- `number` -
+
--- -#### `suggestWords` {#settings-suggestwords} +#### `failFast` {#settings-failfast}
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
-
---- +
Description
+
-#### `suggestionNumChanges` {#settings-suggestionnumchanges} +Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks) -
- -
Description
-
- 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. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-#### `suggestionsTimeout` {#settings-suggestionstimeout} +`boolean` -
- -
Description
-
- The maximum amount of time in milliseconds to generate suggestions for a word. -
- -
Type
-
- `number` -
+
--- -#### `useGitignore` {#settings-usegitignore} +#### `features` {#settings-features}
- -
Description
-
- Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `usePnP` {#settings-usepnp} +Configure CSpell features. -
- -
Description
-
- Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading - packages stored in the repository. - - When true, the spell checker will search up the directory structure for the existence - of a PnP file and load it. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `userWords` {#settings-userwords} +[`Features`](#features) -
- -
Description
-
- Words to add to global dictionary -- should only be in the user config file. -
- -
Type
-
- `string``[]` -
+
--- -#### `validateDirectives` {#settings-validatedirectives} +#### `files` {#settings-files}
- -
Description
-
- Verify that the in-document directives are correct. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `version` {#settings-version} +Glob patterns of files to be checked. -
- -
Description
-
- Configuration format version of the settings file. - - This controls how the settings in the configuration file behave. -
- -
Type
-
- [`Version`](#version) -
-
+Glob patterns are relative to the `globRoot` of the configuration file that defines them. ---- +
-#### `words` {#settings-words} +
Type
+
-
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
+[`Glob`](#glob)`[]` + +
--- -## CacheFormat {#cacheformat} +#### `flagWords` {#settings-flagwords}
- -
Type
-
- `string` -
-
-## CacheSettings - -| Field | Type | Description | -| --------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------- | -| [cacheFormat](#cachesettings-cacheformat) | [`CacheFormat`](#cacheformat) | Format of the cache file. | -| [cacheLocation](#cachesettings-cachelocation) | [`FSPathResolvable`](#fspathresolvable) | Path to the cache location. Can be a file or a directory. | -| [cacheStrategy](#cachesettings-cachestrategy) | [`CacheStrategy`](#cachestrategy) | Strategy to use for detecting changed files, default: metadata | -| [useCache](#cachesettings-usecache) | `boolean` | Store the results of processed files in order to only operate on the changed ones. | +
Description
+
-### CacheSettings Fields +List of words to always be considered incorrect. Words found in `flagWords` override `words`. ---- +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` -#### `cacheFormat` {#cachesettings-cacheformat} +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` -
- -
Description
-
- Format of the cache file. - - `legacy` - use absolute paths in the cache file - - `universal` - use a sharable format. -
- -
Type
-
- [`CacheFormat`](#cacheformat) -
-
+
---- +
Type
+
-#### `cacheLocation` {#cachesettings-cachelocation} +`string``[]` -
- -
Description
-
- Path to the cache location. Can be a file or a directory. - If none specified `.cspellcache` will be used. - Relative paths are relative to the config file in which it - is defined. - - A prefix of `${cwd}` is replaced with the current working directory. -
- -
Type
-
- [`FSPathResolvable`](#fspathresolvable) -
+
--- -#### `cacheStrategy` {#cachesettings-cachestrategy} +#### `gitignoreRoot` {#settings-gitignoreroot}
- -
Description
-
- Strategy to use for detecting changed files, default: metadata -
- -
Type
-
- [`CacheStrategy`](#cachestrategy) -
-
---- +
Description
+
-#### `useCache` {#cachesettings-usecache} +Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. -
- -
Description
-
- Store the results of processed files in order to only operate on the changed ones. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-## CacheStrategy {#cachestrategy} +[`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` -
- -
Description
-
- The Strategy to use to detect if a file has changed. - - `metadata` - uses the file system timestamp and size to detect changes (fastest). - - `content` - uses a hash of the file content to check file changes (slower - more accurate). -
- -
Type
-
- `string` -
+
--- -## CharacterSet {#characterset} +#### `globRoot` {#settings-globroot}
- -
Description
-
- This is a set of characters that can include `-` or `|` - - `-` - indicates a range of characters: `a-c` => `abc` - - `|` - is a group separator, indicating that the characters on either side - are not related. -
- -
Type
-
- `string` -
-
- -## CharacterSetCosts -| Field | Type | Description | -| ------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------- | --- | -| [characters](#charactersetcosts-characters) | [`CharacterSet`](#characterset) | This is a set of characters that can include `-` or ` | ` | -| [cost](#charactersetcosts-cost) | `number` | the cost to insert / delete / replace / swap the characters in a group | -| [penalty](#charactersetcosts-penalty) | `number` | The penalty cost to apply if the accent is used. | +
Description
+
-### CharacterSetCosts Fields +The root to use for glob patterns found in this configuration. +Default: location of the configuration file. + For compatibility reasons, config files with version 0.1, the glob root will + default to be `${cwd}`. ---- +Use `globRoot` to define a different location. +`globRoot` can be relative to the location of this configuration file. +Defining globRoot, does not impact imported configurations. -#### `characters` {#charactersetcosts-characters} +Special Values: +- `${cwd}` - will be replaced with the current working directory. +- `.` - will be the location of the containing configuration file. -
- -
Description
-
- This is a set of characters that can include `-` or `|` - - `-` - indicates a range of characters: `a-c` => `abc` - - `|` - is a group separator, indicating that the characters on either side - are not related. -
- -
Type
-
- [`CharacterSet`](#characterset) -
-
+
---- +
Type
+
-#### `cost` {#charactersetcosts-cost} +[`FSPathResolvable`](#fspathresolvable) -
- -
Description
-
- the cost to insert / delete / replace / swap the characters in a group -
- -
Type
-
- `number` -
+
--- -#### `penalty` {#charactersetcosts-penalty} +#### `id` {#settings-id}
- -
Description
-
- The penalty cost to apply if the accent is used. - This is used to discourage -
- -
Type
-
- `number` -
-
-## CostMapDefInsDel +
Description
+
-| Field | Type | Description | -| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefinsdel-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefinsdel-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefinsdel-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefinsdel-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefinsdel-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefinsdel-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +Optional identifier. -### CostMapDefInsDel Fields +
---- +
Type
+
-#### `description` {#costmapdefinsdel-description} +`string` -
- -
Description
-
- A description to describe the purpose of the map. -
- -
Type
-
- `string` -
+
--- -#### `insDel` {#costmapdefinsdel-insdel} +#### `ignorePaths` {#settings-ignorepaths}
- -
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `map` {#costmapdefinsdel-map} +Glob patterns of files to be ignored. -
- -
Description
-
- The set of substrings to map, these are generally single character strings. - - Multiple sets can be defined by using a `|` to separate them. - - Example: `"eéê|aåá"` contains two different sets. - - To add a multi-character substring use `()`. - - Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. - - - To match the beginning of a word, use `^`: `"(^I)""`. - - To match the end of a word, use `$`: `"(e$)(ing$)"`. -
- -
Type
-
- `string` -
-
+Glob patterns are relative to the `globRoot` of the configuration file that defines them. ---- +
-#### `penalty` {#costmapdefinsdel-penalty} +
Type
+
-
- -
Description
-
- Add a penalty to the final cost. - This is used to discourage certain suggestions. - - Example: - ```yaml - # Match adding/removing `-` to the end of a word. - map: "$(-$)" - replace: 50 - penalty: 100 - ``` - - This makes adding a `-` to the end of a word more expensive. - - Think of it as taking the toll way for speed but getting the bill later. -
- -
Type
-
- `number` -
+[`Glob`](#glob)`[]` + +
--- -#### `replace` {#costmapdefinsdel-replace} +#### `ignoreRegExpList` {#settings-ignoreregexplist}
- -
Description
-
- The cost to replace of of the substrings in the map with another substring in the map. - Example: Map['a', 'i'] - This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `swap` {#costmapdefinsdel-swap} +List of regular expression patterns or pattern names to exclude from spell checking. -
- -
Description
-
- The cost to swap two adjacent substrings found in the map. - Example: Map['e', 'i'] - This represents the cost to change `ei` to `ie` or the reverse. -
- -
Type
-
- `number` -
-
+Example: `["href"]` - to exclude html href pattern. -## CostMapDefReplace +Regular expressions use JavaScript regular expression syntax. -| Field | Type | Description | -| --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefreplace-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefreplace-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefreplace-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefreplace-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefreplace-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefreplace-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +Example: to ignore ALL-CAPS words -### CostMapDefReplace Fields +JSON +```json +"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] +``` ---- +YAML +```yaml +ignoreRegExpList: + - >- + /\b[A-Z]+\b/g +``` -#### `description` {#costmapdefreplace-description} +By default, several patterns are excluded. See +[Configuration](https://cspell.org/configuration/patterns) for more details. -
- -
Description
-
- A description to describe the purpose of the map. -
- -
Type
-
- `string` -
-
+While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). ---- +
-#### `insDel` {#costmapdefreplace-insdel} +
Type
+
-
- -
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
- -
Type
-
- `number` -
+[`RegExpPatternList`](#regexppatternlist) + +
--- -#### `map` {#costmapdefreplace-map} +#### `ignoreWords` {#settings-ignorewords}
- -
Description
-
- The set of substrings to map, these are generally single character strings. - - Multiple sets can be defined by using a `|` to separate them. - - Example: `"eéê|aåá"` contains two different sets. - - To add a multi-character substring use `()`. - - Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. - - - To match the beginning of a word, use `^`: `"(^I)""`. - - To match the end of a word, use `$`: `"(e$)(ing$)"`. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `penalty` {#costmapdefreplace-penalty} +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. -
- -
Description
-
- Add a penalty to the final cost. - This is used to discourage certain suggestions. - - Example: - ```yaml - # Match adding/removing `-` to the end of a word. - map: "$(-$)" - replace: 50 - penalty: 100 - ``` - - This makes adding a `-` to the end of a word more expensive. - - Think of it as taking the toll way for speed but getting the bill later. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-#### `replace` {#costmapdefreplace-replace} +`string``[]` -
- -
Description
-
- The cost to replace of of the substrings in the map with another substring in the map. - Example: Map['a', 'i'] - This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. -
- -
Type
-
- `number` -
+
--- -#### `swap` {#costmapdefreplace-swap} +#### `import` {#settings-import}
- -
Description
-
- The cost to swap two adjacent substrings found in the map. - Example: Map['e', 'i'] - This represents the cost to change `ei` to `ie` or the reverse. -
- -
Type
-
- `number` -
-
-## CostMapDefSwap +
Description
+
-| Field | Type | Description | -| ------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefswap-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefswap-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefswap-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefswap-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefswap-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefswap-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +Allows this configuration to inherit configuration for one or more other files. -### CostMapDefSwap Fields +See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details. ---- +
-#### `description` {#costmapdefswap-description} +
Type
+
-
- -
Description
-
- A description to describe the purpose of the map. -
- -
Type
-
- `string` -
+[`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` + +
--- -#### `insDel` {#costmapdefswap-insdel} +#### `includeRegExpList` {#settings-includeregexplist}
- -
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
- -
Type
-
- `number` -
-
- ---- -#### `map` {#costmapdefswap-map} +
Description
+
-
- -
Description
-
- The set of substrings to map, these are generally single character strings. - - Multiple sets can be defined by using a `|` to separate them. - - Example: `"eéê|aåá"` contains two different sets. - - To add a multi-character substring use `()`. - - Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. - - - To match the beginning of a word, use `^`: `"(^I)""`. - - To match the end of a word, use `$`: `"(e$)(ing$)"`. -
- -
Type
-
- `string` -
-
+List of regular expression patterns or defined pattern names to match for spell checking. ---- +If this property is defined, only text matching the included patterns will be checked. -#### `penalty` {#costmapdefswap-penalty} +While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Description
-
- Add a penalty to the final cost. - This is used to discourage certain suggestions. - - Example: - ```yaml - # Match adding/removing `-` to the end of a word. - map: "$(-$)" - replace: 50 - penalty: 100 - ``` - - This makes adding a `-` to the end of a word more expensive. - - Think of it as taking the toll way for speed but getting the bill later. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-#### `replace` {#costmapdefswap-replace} +[`RegExpPatternList`](#regexppatternlist) -
- -
Description
-
- The cost to replace of of the substrings in the map with another substring in the map. - Example: Map['a', 'i'] - This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. -
- -
Type
-
- `number` -
+
--- -#### `swap` {#costmapdefswap-swap} +#### `language` {#settings-language}
- -
Description
-
- The cost to swap two adjacent substrings found in the map. - Example: Map['e', 'i'] - This represents the cost to change `ei` to `ie` or the reverse. -
- -
Type
-
- `number` -
-
---- +
Description
+
-## CustomDictionaryPath {#customdictionarypath} +Current active spelling language. This specifies the language locale to use in choosing the +general dictionary. -
- -
Description
-
- A File System Path to a dictionary file. -
- -
Type
-
- [`FsDictionaryPath`](#fsdictionarypath) -
-
+For example: ---- +- "en-GB" for British English. +- "en,nl" to enable both English and Dutch. -## CustomDictionaryScope {#customdictionaryscope} +
-
- -
Description
-
- Specifies the scope of a dictionary. -
- -
Type
-
- `string` -
+
Type
+
+ +[`LocaleId`](#localeid) + +
--- -## DictionaryDefinition {#dictionarydefinition} +#### `languageId` {#settings-languageid}
- -
Type
-
- [`DictionaryDefinitionPreferred`](#dictionarydefinitionpreferred)
[`DictionaryDefinitionCustom`](#dictionarydefinitioncustom)
[`DictionaryDefinitionAugmented`](#dictionarydefinitionaugmented)
[`DictionaryDefinitionInline`](#dictionarydefinitioninline)
[`DictionaryDefinitionAlternate`](#dictionarydefinitionalternate) -
-
-## DictionaryDefinitionAlternate +
Description
+
-| Field | Type | Description | -| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionalternate-description) | `string` | Optional description. | -| [file](#dictionarydefinitionalternate-file) | [`DictionaryPath`](#dictionarypath) | Path to the file, only for legacy dictionary definitions. | -| [name](#dictionarydefinitionalternate-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionalternate-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitionalternate-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionalternate-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionalternate-usecompounds) | `boolean` | Use Compounds. | +Forces the spell checker to assume a give language id. Used mainly as an Override. -### DictionaryDefinitionAlternate Fields +
---- +
Type
+
-#### `description` {#dictionarydefinitionalternate-description} +[`MatchingFileType`](#matchingfiletype) -
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
+
--- -#### `file` {#dictionarydefinitionalternate-file} +#### `languageSettings` {#settings-languagesettings}
- -
Description
-
- Path to the file, only for legacy dictionary definitions. -
- -
Type
-
- [`DictionaryPath`](#dictionarypath) -
-
---- +
Description
+
-#### `name` {#dictionarydefinitionalternate-name} +Additional settings for individual languages. -
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
+See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. ---- +
-#### `noSuggest` {#dictionarydefinitionalternate-nosuggest} +
Type
+
-
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
+[`LanguageSetting`](#languagesetting)`[]` + +
--- -#### `repMap` {#dictionarydefinitionalternate-repmap} +#### `loadDefaultConfiguration` {#settings-loaddefaultconfiguration}
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
-
---- +
Description
+
-#### `type` {#dictionarydefinitionalternate-type} +By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` +will prevent ALL default configuration from being loaded. -
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
+
+ +
Type
+
+ +`boolean` + +
--- -#### `useCompounds` {#dictionarydefinitionalternate-usecompounds} +#### `maxDuplicateProblems` {#settings-maxduplicateproblems}
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
-
-## DictionaryDefinitionAugmented +
Description
+
-| Field | Type | Description | -| ----------------------------------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionaugmented-description) | `string` | Optional description. | -| [dictionaryInformation](#dictionarydefinitionaugmented-dictionaryinformation) | [`DictionaryInformation`](#dictionaryinformation) | | -| [name](#dictionarydefinitionaugmented-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionaugmented-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitionaugmented-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | -| [repMap](#dictionarydefinitionaugmented-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionaugmented-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionaugmented-usecompounds) | `boolean` | Use Compounds. | +The maximum number of times the same word can be flagged as an error in a file. -### DictionaryDefinitionAugmented Fields +
---- +
Type
+
-#### `description` {#dictionarydefinitionaugmented-description} +`number` -
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
+
--- -#### `dictionaryInformation` {#dictionarydefinitionaugmented-dictionaryinformation} +#### `maxNumberOfProblems` {#settings-maxnumberofproblems}
- -
Type
-
- [`DictionaryInformation`](#dictionaryinformation) -
-
---- +
Description
+
-#### `name` {#dictionarydefinitionaugmented-name} +The maximum number of problems to report in a file. -
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
+
---- +
Type
+
-#### `noSuggest` {#dictionarydefinitionaugmented-nosuggest} +`number` -
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
+
--- -#### `path` {#dictionarydefinitionaugmented-path} +#### `minWordLength` {#settings-minwordlength}
- -
Description
-
- Path to the file. -
- -
Type
-
- [`DictionaryPath`](#dictionarypath) -
-
---- +
Description
+
-#### `repMap` {#dictionarydefinitionaugmented-repmap} +The minimum length of a word before checking it against a dictionary. -
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
-
+
---- +
Type
+
-#### `type` {#dictionarydefinitionaugmented-type} +`number` -
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
+
--- -#### `useCompounds` {#dictionarydefinitionaugmented-usecompounds} +#### `name` {#settings-name}
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
-
-## DictionaryDefinitionCustom +
Description
+
-| Field | Type | Description | -| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| [addWords](#dictionarydefinitioncustom-addwords) | `boolean` | When `true`, let's the spell checker know that words can be added to this dictionary. | -| [description](#dictionarydefinitioncustom-description) | `string` | Optional description. | -| [name](#dictionarydefinitioncustom-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioncustom-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitioncustom-path) | [`CustomDictionaryPath`](#customdictionarypath) | Path to custom dictionary text file. | -| [repMap](#dictionarydefinitioncustom-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [scope](#dictionarydefinitioncustom-scope) | [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` | Defines the scope for when words will be added to the dictionary. | -| [type](#dictionarydefinitioncustom-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioncustom-usecompounds) | `boolean` | Use Compounds. | +Optional name of configuration. -### DictionaryDefinitionCustom Fields +
---- +
Type
+
-#### `addWords` {#dictionarydefinitioncustom-addwords} +`string` -
- -
Description
-
- When `true`, let's the spell checker know that words can be added to this dictionary. -
- -
Type
-
- `boolean` -
+
--- -#### `description` {#dictionarydefinitioncustom-description} +#### `noConfigSearch` {#settings-noconfigsearch}
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `name` {#dictionarydefinitioncustom-name} +Prevents searching for local configuration when checking individual documents. -
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
+
---- +
Type
+
-#### `noSuggest` {#dictionarydefinitioncustom-nosuggest} +`boolean` -
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
+
--- -#### `path` {#dictionarydefinitioncustom-path} +#### `noSuggestDictionaries` {#settings-nosuggestdictionaries}
- -
Description
-
- Path to custom dictionary text file. -
- -
Type
-
- [`CustomDictionaryPath`](#customdictionarypath) -
-
---- +
Description
+
-#### `repMap` {#dictionarydefinitioncustom-repmap} +Optional list of dictionaries that will not be used for suggestions. +Words in these dictionaries are considered correct, but will not be +used when making spell correction suggestions. -
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
-
+Note: if a word is suggested by another dictionary, but found in +one of these dictionaries, it will be removed from the set of +possible suggestions. ---- +
-#### `scope` {#dictionarydefinitioncustom-scope} +
Type
+
-
- -
Description
-
- Defines the scope for when words will be added to the dictionary. - - Scope values: `user`, `workspace`, `folder`. -
- -
Type
-
- [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` -
+[`DictionaryReference`](#dictionaryreference)`[]` + +
--- -#### `type` {#dictionarydefinitioncustom-type} +#### `numSuggestions` {#settings-numsuggestions}
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
-
---- +
Description
+
-#### `useCompounds` {#dictionarydefinitioncustom-usecompounds} +Number of suggestions to make. -
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
+
+ +
Type
+
+ +`number` + +
--- -## DictionaryDefinitionInline {#dictionarydefinitioninline} +#### `overrides` {#settings-overrides}
- -
Description
-
- Inline Dictionary Definitions -
- -
Type
-
- [`DictionaryDefinitionInlineWords`](#dictionarydefinitioninlinewords)
[`DictionaryDefinitionInlineIgnoreWords`](#dictionarydefinitioninlineignorewords)
[`DictionaryDefinitionInlineFlagWords`](#dictionarydefinitioninlineflagwords) -
-
-## DictionaryDefinitionInlineFlagWords +
Description
+
-| Field | Type | Description | -| ----------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlineflagwords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlineflagwords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlineflagwords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlineflagwords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineflagwords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineflagwords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineflagwords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineflagwords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlineflagwords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlineflagwords-words) | `string``[]` | List of words to be considered correct. | +Overrides are used to apply settings for specific files in your project. -### DictionaryDefinitionInlineFlagWords Fields +For example: ---- +```javascript +"overrides": [ + // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: + { + "filename": "**/{*.hrr,*.crr}", + "languageId": "cpp" + }, + // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately): + { + "language": "nl", + "filename": "**/dutch/**/*.txt" + } +] +``` -#### `description` {#dictionarydefinitioninlineflagwords-description} +
-
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
+
Type
+
+ +[`OverrideSettings`](#overridesettings)`[]` + +
--- -#### `flagWords` {#dictionarydefinitioninlineflagwords-flagwords} +#### `patterns` {#settings-patterns}
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
-
---- +
Description
+
-#### `ignoreWords` {#dictionarydefinitioninlineflagwords-ignorewords} +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. -
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
-
+For example: ---- +```javascript +"ignoreRegExpList": ["comments"], +"patterns": [ + { + "name": "comment-single-line", + "pattern": "/#.*/g" + }, + { + "name": "comment-multi-line", + "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" + }, + // You can also combine multiple named patterns into one single named pattern + { + "name": "comments", + "pattern": ["comment-single-line", "comment-multi-line"] + } +] +``` +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. -#### `name` {#dictionarydefinitioninlineflagwords-name} +
-
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
+
Type
+
+ +[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` + +
--- -#### `noSuggest` {#dictionarydefinitioninlineflagwords-nosuggest} +#### `pnpFiles` {#settings-pnpfiles}
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `repMap` {#dictionarydefinitioninlineflagwords-repmap} +The PnP files to search for. Note: `.mjs` files are not currently supported. -
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
-
+
---- +
Type
+
-#### `suggestWords` {#dictionarydefinitioninlineflagwords-suggestwords} +`string``[]` -
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
+
--- -#### `type` {#dictionarydefinitioninlineflagwords-type} +#### `readonly` {#settings-readonly}
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
-
---- +
Description
+
-#### `useCompounds` {#dictionarydefinitioninlineflagwords-usecompounds} +Indicate that the configuration file should not be modified. +This is used to prevent tools like the VS Code Spell Checker from +modifying the file to add words and other configuration. -
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
+
+ +
Type
+
+ +`boolean` + +
--- -#### `words` {#dictionarydefinitioninlineflagwords-words} +#### `reporters` {#settings-reporters}
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
-
-## DictionaryDefinitionInlineIgnoreWords +
Description
+
-| Field | Type | Description | -| ------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlineignorewords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlineignorewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlineignorewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlineignorewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineignorewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineignorewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineignorewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineignorewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlineignorewords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlineignorewords-words) | `string``[]` | List of words to be considered correct. | - -### DictionaryDefinitionInlineIgnoreWords Fields - ---- +Define which reports to use. +`default` - is a special name for the default cli reporter. -#### `description` {#dictionarydefinitioninlineignorewords-description} +Examples: +- `["default"]` - to use the default reporter +- `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter. +- `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` +- `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter. -
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
-
+
---- +
Type
+
-#### `flagWords` {#dictionarydefinitioninlineignorewords-flagwords} +[`ReporterSettings`](#reportersettings)`[]` -
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
+
--- -#### `ignoreWords` {#dictionarydefinitioninlineignorewords-ignorewords} +#### `showStatus` {#settings-showstatus}
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
-
---- +
Description
+
-#### `name` {#dictionarydefinitioninlineignorewords-name} +Show status. -
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
+
---- +
Type
+
-#### `noSuggest` {#dictionarydefinitioninlineignorewords-nosuggest} +`boolean` -
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
+
--- -#### `repMap` {#dictionarydefinitioninlineignorewords-repmap} +#### `spellCheckDelayMs` {#settings-spellcheckdelayms}
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
-
---- +
Description
+
-#### `suggestWords` {#dictionarydefinitioninlineignorewords-suggestwords} +Delay in ms after a document has changed before checking it for spelling errors. -
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
-
+
---- +
Type
+
-#### `type` {#dictionarydefinitioninlineignorewords-type} +`number` -
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
+
--- -#### `useCompounds` {#dictionarydefinitioninlineignorewords-usecompounds} +#### `suggestWords` {#settings-suggestwords}
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `words` {#dictionarydefinitioninlineignorewords-words} +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. -
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
-
+Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` -## DictionaryDefinitionInlineWords +
-| Field | Type | Description | -| ------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlinewords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlinewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlinewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlinewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlinewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlinewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlinewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlinewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlinewords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlinewords-words) | `string``[]` | List of words to be considered correct. | +
Type
+
-### DictionaryDefinitionInlineWords Fields +`string``[]` + +
+ --- -#### `description` {#dictionarydefinitioninlinewords-description} +#### `suggestionNumChanges` {#settings-suggestionnumchanges}
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `flagWords` {#dictionarydefinitioninlinewords-flagwords} +The maximum number of changes allowed on a word to be considered a suggestions. -
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
-
+For example, appending an `s` onto `example` -> `examples` is considered 1 change. ---- +Range: between 1 and 5. -#### `ignoreWords` {#dictionarydefinitioninlinewords-ignorewords} +
-
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
+
Type
+
+ +`number` + +
--- -#### `name` {#dictionarydefinitioninlinewords-name} +#### `suggestionsTimeout` {#settings-suggestionstimeout}
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
---- +
Description
+
-#### `noSuggest` {#dictionarydefinitioninlinewords-nosuggest} +The maximum amount of time in milliseconds to generate suggestions for a word. -
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `repMap` {#dictionarydefinitioninlinewords-repmap} +`number` -
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
+
--- -#### `suggestWords` {#dictionarydefinitioninlinewords-suggestwords} +#### `useGitignore` {#settings-usegitignore}
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
-
---- +
Description
+
-#### `type` {#dictionarydefinitioninlinewords-type} +Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. -
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
-
+
---- +
Type
+
-#### `useCompounds` {#dictionarydefinitioninlinewords-usecompounds} +`boolean` -
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
+
--- -#### `words` {#dictionarydefinitioninlinewords-words} +#### `usePnP` {#settings-usepnp}
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
-
- -## DictionaryDefinitionPreferred - -| Field | Type | Description | -| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionpreferred-description) | `string` | Optional description. | -| [name](#dictionarydefinitionpreferred-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionpreferred-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitionpreferred-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | -| [repMap](#dictionarydefinitionpreferred-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionpreferred-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionpreferred-usecompounds) | `boolean` | Use Compounds. | -### DictionaryDefinitionPreferred Fields +
Description
+
---- +Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading +packages stored in the repository. -#### `description` {#dictionarydefinitionpreferred-description} +When true, the spell checker will search up the directory structure for the existence +of a PnP file and load it. -
- -
Description
-
- Optional description. -
- -
Type
-
- `string` -
-
+
---- +
Type
+
-#### `name` {#dictionarydefinitionpreferred-name} +`boolean` -
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
+
--- -#### `noSuggest` {#dictionarydefinitionpreferred-nosuggest} +#### `userWords` {#settings-userwords}
- -
Description
-
- Indicate that suggestions should not come from this dictionary. - Words in this dictionary are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - this dictionary, it will be removed from the set of - possible suggestions. -
- -
Type
-
- `boolean` -
-
---- +
Description
+
-#### `path` {#dictionarydefinitionpreferred-path} +Words to add to global dictionary -- should only be in the user config file. -
- -
Description
-
- Path to the file. -
- -
Type
-
- [`DictionaryPath`](#dictionarypath) -
-
+
---- +
Type
+
-#### `repMap` {#dictionarydefinitionpreferred-repmap} +`string``[]` -
- -
Description
-
- Replacement pairs. -
- -
Type
-
- [`ReplaceMap`](#replacemap) -
+
--- -#### `type` {#dictionarydefinitionpreferred-type} +#### `validateDirectives` {#settings-validatedirectives}
- -
Description
-
- Type of file: - - S - single word per line, - - W - each line can contain one or more words separated by space, - - C - each line is treated like code (Camel Case is allowed). - - Default is S. - - C is the slowest to load due to the need to split each line based upon code splitting rules. -
- -
Type
-
- [`DictionaryFileTypes`](#dictionaryfiletypes) -
-
---- +
Description
+
-#### `useCompounds` {#dictionarydefinitionpreferred-usecompounds} +Verify that the in-document directives are correct. -
- -
Description
-
- Use Compounds. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-## DictionaryFileTypes {#dictionaryfiletypes} +`boolean` -
- -
Type
-
- `string` -
+
--- -## DictionaryId {#dictionaryid} +#### `version` {#settings-version}
- -
Description
-
- This is the name of a dictionary. - - Name Format: - - Must contain at least 1 number or letter. - - Spaces are allowed. - - Leading and trailing space will be removed. - - Names ARE case-sensitive. - - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
- -
Type
-
- `string` -
-
-## DictionaryInformation +
Description
+
-| Field | Type | Description | -| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| [accents](#dictionaryinformation-accents) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The accent characters. | -| [adjustments](#dictionaryinformation-adjustments) | [`PatternAdjustment`](#patternadjustment)`[]` | A collection of patterns to test against the suggested words. | -| [alphabet](#dictionaryinformation-alphabet) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The alphabet to use. | -| [costs](#dictionaryinformation-costs) | [`EditCosts`](#editcosts) | Define edit costs. | -| [hunspellInformation](#dictionaryinformation-hunspellinformation) | [`HunspellInformation`](#hunspellinformation) | Used by dictionary authors | -| [ignore](#dictionaryinformation-ignore) | [`CharacterSet`](#characterset) | An optional set of characters that can possibly be removed from a word before | -| [locale](#dictionaryinformation-locale) | `string` | The locale of the dictionary. | -| [suggestionEditCosts](#dictionaryinformation-suggestioneditcosts) | [`SuggestionCostsDefs`](#suggestioncostsdefs) | Used in making suggestions. The lower the value, the more likely the suggestion | +Configuration format version of the settings file. -### DictionaryInformation Fields +This controls how the settings in the configuration file behave. ---- +
-#### `accents` {#dictionaryinformation-accents} +
Type
+
-
- -
Description
-
- The accent characters. - - Default: `"\u0300-\u0341"` -
- -
Type
-
- [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` -
+[`Version`](#version) + +
--- -#### `adjustments` {#dictionaryinformation-adjustments} +#### `words` {#settings-words}
- -
Description
-
- A collection of patterns to test against the suggested words. - If the word matches the pattern, then the penalty is applied. -
- -
Type
-
- [`PatternAdjustment`](#patternadjustment)`[]` -
-
---- +
Description
+
-#### `alphabet` {#dictionaryinformation-alphabet} +List of words to be considered correct. -
- -
Description
-
- The alphabet to use. -
- -
Type
-
- [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` -
-
+
---- +
Type
+
-#### `costs` {#dictionaryinformation-costs} +`string``[]` -
- -
Description
-
- Define edit costs. -
- -
Type
-
- [`EditCosts`](#editcosts) -
+
--- -#### `hunspellInformation` {#dictionaryinformation-hunspellinformation} +## CacheFormat {#cacheformat}
- -
Description
-
- Used by dictionary authors -
- -
Type
-
- [`HunspellInformation`](#hunspellinformation) -
-
---- +
Type
+
-#### `ignore` {#dictionaryinformation-ignore} +`string` -
- -
Description
-
- An optional set of characters that can possibly be removed from a word before - checking it. - - This is useful in languages like Arabic where Harakat accents are optional. - - Note: All matching characters are removed or none. Partial removal is not supported. -
- -
Type
-
- [`CharacterSet`](#characterset) -
+
---- +## CacheSettings -#### `locale` {#dictionaryinformation-locale} +| Field | Type | Description | +| --------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------- | +| [cacheFormat](#cachesettings-cacheformat) | [`CacheFormat`](#cacheformat) | Format of the cache file. | +| [cacheLocation](#cachesettings-cachelocation) | [`FSPathResolvable`](#fspathresolvable) | Path to the cache location. Can be a file or a directory. | +| [cacheStrategy](#cachesettings-cachestrategy) | [`CacheStrategy`](#cachestrategy) | Strategy to use for detecting changed files, default: metadata | +| [useCache](#cachesettings-usecache) | `boolean` | Store the results of processed files in order to only operate on the changed ones. | -
- -
Description
-
- The locale of the dictionary. - Example: `nl,nl-be` -
- -
Type
-
- `string` -
-
+### CacheSettings Fields --- -#### `suggestionEditCosts` {#dictionaryinformation-suggestioneditcosts} +#### `cacheFormat` {#cachesettings-cacheformat}
- -
Description
-
- Used in making suggestions. The lower the value, the more likely the suggestion - will be near the top of the suggestion list. -
- -
Type
-
- [`SuggestionCostsDefs`](#suggestioncostsdefs) -
-
---- +
Description
+
-## DictionaryNegRef {#dictionarynegref} +Format of the cache file. +- `legacy` - use absolute paths in the cache file +- `universal` - use a sharable format. -
- -
Description
-
- This a negative reference to a named dictionary. - - It is used to exclude or include a dictionary by name. - - The reference starts with 1 or more `!`. - - `!` - Used to exclude the dictionary matching ``. - - `!!` - Used to re-include a dictionary matching ``. - Overrides `!`. - - `!!!` - Used to exclude a dictionary matching ``. - Overrides `!!`. -
- -
Type
-
- `string` -
-
+
---- +
Type
+
-## DictionaryPath {#dictionarypath} +[`CacheFormat`](#cacheformat) -
- -
Description
-
- A File System Path to a dictionary file. - Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$` -
- -
Type
-
- `string` -
+
--- -## DictionaryRef {#dictionaryref} +#### `cacheLocation` {#cachesettings-cachelocation}
- -
Description
-
- This a reference to a named dictionary. - It is expected to match the name of a dictionary. -
- -
Type
-
- [`DictionaryId`](#dictionaryid) -
-
---- +
Description
+
-## DictionaryReference {#dictionaryreference} +Path to the cache location. Can be a file or a directory. +If none specified `.cspellcache` will be used. +Relative paths are relative to the config file in which it +is defined. -
- -
Description
-
- Reference to a dictionary by name. - One of: - - [DictionaryRef](#dictionaryref) - - [DictionaryNegRef](#dictionarynegref) -
- -
Type
-
- [`DictionaryRef`](#dictionaryref)
[`DictionaryNegRef`](#dictionarynegref) -
-
+A prefix of `${cwd}` is replaced with the current working directory. -## EditCosts +
-| Field | Type | Description | -| --------------------------------------------------- | -------- | ---------------------------------------------------------------- | -| [accentCosts](#editcosts-accentcosts) | `number` | The cost to add / remove an accent | -| [baseCost](#editcosts-basecost) | `number` | This is the base cost for making an edit. | -| [capsCosts](#editcosts-capscosts) | `number` | The cost to change capitalization. | -| [firstLetterPenalty](#editcosts-firstletterpenalty) | `number` | The extra cost incurred for changing the first letter of a word. | -| [nonAlphabetCosts](#editcosts-nonalphabetcosts) | `number` | This is the cost for characters not in the alphabet. | +
Type
+
-### EditCosts Fields +[`FSPathResolvable`](#fspathresolvable) + +
+ --- -#### `accentCosts` {#editcosts-accentcosts} +#### `cacheStrategy` {#cachesettings-cachestrategy}
- -
Description
-
- The cost to add / remove an accent - This should be very cheap, it helps with fixing accent issues. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `baseCost` {#editcosts-basecost} +Strategy to use for detecting changed files, default: metadata -
- -
Description
-
- This is the base cost for making an edit. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-#### `capsCosts` {#editcosts-capscosts} +[`CacheStrategy`](#cachestrategy) -
- -
Description
-
- The cost to change capitalization. - This should be very cheap, it helps with fixing capitalization issues. -
- -
Type
-
- `number` -
+
--- -#### `firstLetterPenalty` {#editcosts-firstletterpenalty} +#### `useCache` {#cachesettings-usecache}
- -
Description
-
- The extra cost incurred for changing the first letter of a word. - This value should be less than `100 - baseCost`. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `nonAlphabetCosts` {#editcosts-nonalphabetcosts} +Store the results of processed files in order to only operate on the changed ones. -
- -
Description
-
- This is the cost for characters not in the alphabet. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-## FSPathResolvable {#fspathresolvable} +`boolean` -
- -
Description
-
- A File System Path. - - Special Properties: - - `${cwd}` prefix - will be replaced with the current working directory. - - Relative paths are relative to the configuration file. -
- -
Type
-
- [`FsPath`](#fspath) -
+
--- -## FeatureEnableOnly {#featureenableonly} +## CacheStrategy {#cachestrategy}
- -
Type
-
- `boolean` -
-
-## Features +
Description
+
-| Field | Type | Description | -| ------------------------------------------------------ | ----------------------------------------- | ------------------------------------------ | -| [weighted-suggestions](#features-weighted-suggestions) | [`FeatureEnableOnly`](#featureenableonly) | Enable/disable using weighted suggestions. | +The Strategy to use to detect if a file has changed. +- `metadata` - uses the file system timestamp and size to detect changes (fastest). +- `content` - uses a hash of the file content to check file changes (slower - more accurate). -### Features Fields +
---- +
Type
+
-#### `weighted-suggestions` {#features-weighted-suggestions} +`string` -
- -
Description
-
- Enable/disable using weighted suggestions. -
- -
Type
-
- [`FeatureEnableOnly`](#featureenableonly) -
+
--- -## FsDictionaryPath {#fsdictionarypath} +## CharacterSet {#characterset}
- -
Description
-
- A File System Path. Relative paths are relative to the configuration file. -
- -
Type
-
- `string` -
-
---- +
Description
+
-## FsPath {#fspath} +This is a set of characters that can include `-` or `|` +- `-` - indicates a range of characters: `a-c` => `abc` +- `|` - is a group separator, indicating that the characters on either side + are not related. -
- -
Description
-
- A File System Path. Relative paths are relative to the configuration file. -
- -
Type
-
- `string` -
-
+
---- +
Type
+
-## Glob {#glob} +`string` -
- -
Description
-
- These are glob expressions. -
- -
Type
-
- [`SimpleGlob`](#simpleglob) -
+
-## HunspellInformation +## CharacterSetCosts -| Field | Type | Description | -| ----------------------------------- | -------- | --------------------------------------------------- | -| [aff](#hunspellinformation-aff) | `string` | Selected Hunspell AFF content. | -| [costs](#hunspellinformation-costs) | `object` | The costs to apply when using the hunspell settings | +| Field | Type | Description | +| ------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------- | --- | +| [characters](#charactersetcosts-characters) | [`CharacterSet`](#characterset) | This is a set of characters that can include `-` or ` | ` | +| [cost](#charactersetcosts-cost) | `number` | the cost to insert / delete / replace / swap the characters in a group | +| [penalty](#charactersetcosts-penalty) | `number` | The penalty cost to apply if the accent is used. | -### HunspellInformation Fields +### CharacterSetCosts Fields --- -#### `aff` {#hunspellinformation-aff} +#### `characters` {#charactersetcosts-characters}
- -
Description
-
- Selected Hunspell AFF content. - The content must be UTF-8 - - Sections: - - TRY - - MAP - - REP - - KEY - - ICONV - - OCONV - - Example: - ```hunspell - # Comment - TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` - MAP aàâäAÀÂÄ - MAP eéèêëEÉÈÊË - MAP iîïyIÎÏY - MAP oôöOÔÖ - MAP (IJ)(IJ) - ``` -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `costs` {#hunspellinformation-costs} +This is a set of characters that can include `-` or `|` +- `-` - indicates a range of characters: `a-c` => `abc` +- `|` - is a group separator, indicating that the characters on either side + are not related. -
- -
Description
-
- The costs to apply when using the hunspell settings -
- -
Type
-
- `object` -
-
+
---- +
Type
+
-## LanguageId {#languageid} +[`CharacterSet`](#characterset) -
- -
Type
-
- [`LanguageIdSingle`](#languageidsingle)
[`LanguageIdMultiple`](#languageidmultiple)
[`LanguageIdMultipleNeg`](#languageidmultipleneg) -
+
--- -## LanguageIdMultiple {#languageidmultiple} +#### `cost` {#charactersetcosts-cost}
- -
Description
-
- This can be 'typescript,cpp,json,literal haskell', etc. -
- -
Type
-
- `string` -
-
---- +
Description
+
-## LanguageIdMultipleNeg {#languageidmultipleneg} +the cost to insert / delete / replace / swap the characters in a group -
- -
Description
-
- This can be 'typescript,cpp,json,literal haskell', etc. -
- -
Type
-
- `string` -
+
+ +
Type
+
+ +`number` + +
--- -## LanguageIdSingle {#languageidsingle} +#### `penalty` {#charactersetcosts-penalty}
- -
Description
-
- This can be '*', 'typescript', 'cpp', 'json', etc. -
- -
Type
-
- `string` -
-
-## LanguageSetting +
Description
+
-| Field | Type | Description | -| --------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [allowCompoundWords](#languagesetting-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | -| [caseSensitive](#languagesetting-casesensitive) | `boolean` | Determines if words must match case and accent rules. | -| [description](#languagesetting-description) | `string` | Optional description of configuration. | -| [dictionaries](#languagesetting-dictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#languagesetting-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)`[]` | Define additional available dictionaries. | -| [enabled](#languagesetting-enabled) | `boolean` | Is the spell checker enabled. | -| [flagWords](#languagesetting-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [id](#languagesetting-id) | `string` | Optional identifier. | -| [ignoreRegExpList](#languagesetting-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | -| [ignoreWords](#languagesetting-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [includeRegExpList](#languagesetting-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | -| [languageId](#languagesetting-languageid) | [`MatchingFileType`](#matchingfiletype) | The language id. Ex: "typescript", "html", or "php". "\*" -- will match all languages. | -| [local](#languagesetting-local) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | Deprecated - The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | -| [locale](#languagesetting-locale) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | -| [name](#languagesetting-name) | `string` | Optional name of configuration. | -| [noSuggestDictionaries](#languagesetting-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries that will not be used for suggestions. | -| [patterns](#languagesetting-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | -| [suggestWords](#languagesetting-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [words](#languagesetting-words) | `string``[]` | List of words to be considered correct. | +The penalty cost to apply if the accent is used. +This is used to discourage -### LanguageSetting Fields +
---- +
Type
+
-#### `allowCompoundWords` {#languagesetting-allowcompoundwords} +`number` -
- -
Description
-
- True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. -
- -
Type
-
- `boolean` -
+
---- +## CostMapDefInsDel -#### `caseSensitive` {#languagesetting-casesensitive} +| Field | Type | Description | +| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| [description](#costmapdefinsdel-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefinsdel-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefinsdel-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefinsdel-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefinsdel-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefinsdel-swap) | `number` | The cost to swap two adjacent substrings found in the map. | -
- -
Description
-
- Determines if words must match case and accent rules. - - - `false` - Case is ignored and accents can be missing on the entire word. - Incorrect accents or partially missing accents will be marked as incorrect. - - `true` - Case and accents are enforced. -
- -
Type
-
- `boolean` -
-
+### CostMapDefInsDel Fields --- -#### `description` {#languagesetting-description} +#### `description` {#costmapdefinsdel-description}
- -
Description
-
- Optional description of configuration. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `dictionaries` {#languagesetting-dictionaries} +A description to describe the purpose of the map. -
- -
Description
-
- Optional list of dictionaries to use. Each entry should match the name of the dictionary. - - To remove a dictionary from the list, add `!` before the name. - - For example, `!typescript` will turn off the dictionary with the name `typescript`. - - See the [Dictionaries](https://cspell.org/docs/dictionaries/) - and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
-
+
---- +
Type
+
-#### `dictionaryDefinitions` {#languagesetting-dictionarydefinitions} +`string` -
- -
Description
-
- Define additional available dictionaries. - - For example, you can use the following to add a custom dictionary: - - ```json - "dictionaryDefinitions": [ - { "name": "custom-words", "path": "./custom-words.txt"} - ], - "dictionaries": ["custom-words"] - ``` -
- -
Type
-
- [`DictionaryDefinition`](#dictionarydefinition)`[]` -
+
--- -#### `enabled` {#languagesetting-enabled} +#### `insDel` {#costmapdefinsdel-insdel}
- -
Description
-
- Is the spell checker enabled. -
- -
Type
-
- `boolean` -
+ +
Description
+
+ +The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. + +
+ +
Type
+
+ +`number` + +
--- -#### `flagWords` {#languagesetting-flagwords} +#### `map` {#costmapdefinsdel-map}
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +The set of substrings to map, these are generally single character strings. + +Multiple sets can be defined by using a `|` to separate them. + +Example: `"eéê|aåá"` contains two different sets. + +To add a multi-character substring use `()`. + +Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. + +- To match the beginning of a word, use `^`: `"(^I)""`. +- To match the end of a word, use `$`: `"(e$)(ing$)"`. + +
+ +
Type
+
+ +`string` + +
--- -#### `id` {#languagesetting-id} +#### `penalty` {#costmapdefinsdel-penalty}
- -
Description
-
- Optional identifier. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Add a penalty to the final cost. +This is used to discourage certain suggestions. + +Example: +```yaml +# Match adding/removing `-` to the end of a word. +map: "$(-$)" +replace: 50 +penalty: 100 +``` + +This makes adding a `-` to the end of a word more expensive. + +Think of it as taking the toll way for speed but getting the bill later. + +
+ +
Type
+
+ +`number` + +
--- -#### `ignoreRegExpList` {#languagesetting-ignoreregexplist} +#### `replace` {#costmapdefinsdel-replace}
- -
Description
-
- List of regular expression patterns or pattern names to exclude from spell checking. - - Example: `["href"]` - to exclude html href pattern. - - Regular expressions use JavaScript regular expression syntax. - - Example: to ignore ALL-CAPS words - - JSON - ```json - "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] - ``` - - YAML - ```yaml - ignoreRegExpList: - - >- - /\b[A-Z]+\b/g - ``` - - By default, several patterns are excluded. See - [Configuration](https://cspell.org/configuration/patterns) for more details. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
+ +
Description
+
+ +The cost to replace of of the substrings in the map with another substring in the map. +Example: Map['a', 'i'] +This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. + +
+ +
Type
+
+ +`number` + +
--- -#### `ignoreWords` {#languagesetting-ignorewords} +#### `swap` {#costmapdefinsdel-swap}
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +The cost to swap two adjacent substrings found in the map. +Example: Map['e', 'i'] +This represents the cost to change `ei` to `ie` or the reverse. + +
+ +
Type
+
+ +`number` + +
+## CostMapDefReplace + +| Field | Type | Description | +| --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| [description](#costmapdefreplace-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefreplace-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefreplace-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefreplace-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefreplace-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefreplace-swap) | `number` | The cost to swap two adjacent substrings found in the map. | + +### CostMapDefReplace Fields + --- -#### `includeRegExpList` {#languagesetting-includeregexplist} +#### `description` {#costmapdefreplace-description}
- -
Description
-
- List of regular expression patterns or defined pattern names to match for spell checking. - - If this property is defined, only text matching the included patterns will be checked. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
+ +
Description
+
+ +A description to describe the purpose of the map. + +
+ +
Type
+
+ +`string` + +
--- -#### `languageId` {#languagesetting-languageid} +#### `insDel` {#costmapdefreplace-insdel}
- -
Description
-
- The language id. Ex: "typescript", "html", or "php". "*" -- will match all languages. -
- -
Type
-
- [`MatchingFileType`](#matchingfiletype) -
+ +
Description
+
+ +The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. + +
+ +
Type
+
+ +`number` + +
--- -#### `local` {#languagesetting-local} +#### `map` {#costmapdefreplace-map}
- -
Description
-
- Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. -
- -
Type
-
- [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` -
+ +
Description
+
+ +The set of substrings to map, these are generally single character strings. + +Multiple sets can be defined by using a `|` to separate them. + +Example: `"eéê|aåá"` contains two different sets. + +To add a multi-character substring use `()`. + +Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. + +- To match the beginning of a word, use `^`: `"(^I)""`. +- To match the end of a word, use `$`: `"(e$)(ing$)"`. + +
+ +
Type
+
+ +`string` + +
--- -#### `locale` {#languagesetting-locale} +#### `penalty` {#costmapdefreplace-penalty}
- -
Description
-
- The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. -
- -
Type
-
- [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` -
+ +
Description
+
+ +Add a penalty to the final cost. +This is used to discourage certain suggestions. + +Example: +```yaml +# Match adding/removing `-` to the end of a word. +map: "$(-$)" +replace: 50 +penalty: 100 +``` + +This makes adding a `-` to the end of a word more expensive. + +Think of it as taking the toll way for speed but getting the bill later. + +
+ +
Type
+
+ +`number` + +
--- -#### `name` {#languagesetting-name} +#### `replace` {#costmapdefreplace-replace}
- -
Description
-
- Optional name of configuration. -
- -
Type
-
- `string` -
+ +
Description
+
+ +The cost to replace of of the substrings in the map with another substring in the map. +Example: Map['a', 'i'] +This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. + +
+ +
Type
+
+ +`number` + +
--- -#### `noSuggestDictionaries` {#languagesetting-nosuggestdictionaries} +#### `swap` {#costmapdefreplace-swap}
- -
Description
-
- Optional list of dictionaries that will not be used for suggestions. - Words in these dictionaries are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - one of these dictionaries, it will be removed from the set of - possible suggestions. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
+ +
Description
+
+ +The cost to swap two adjacent substrings found in the map. +Example: Map['e', 'i'] +This represents the cost to change `ei` to `ie` or the reverse. + +
+ +
Type
+
+ +`number` + +
+## CostMapDefSwap + +| Field | Type | Description | +| ------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------ | +| [description](#costmapdefswap-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefswap-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefswap-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefswap-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefswap-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefswap-swap) | `number` | The cost to swap two adjacent substrings found in the map. | + +### CostMapDefSwap Fields + --- -#### `patterns` {#languagesetting-patterns} +#### `description` {#costmapdefswap-description}
- -
Description
-
- Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. - - For example: - - ```javascript - "ignoreRegExpList": ["comments"], - "patterns": [ - { - "name": "comment-single-line", - "pattern": "/#.*/g" - }, - { - "name": "comment-multi-line", - "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" - }, - // You can also combine multiple named patterns into one single named pattern - { - "name": "comments", - "pattern": ["comment-single-line", "comment-multi-line"] - } - ] - ``` - Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. -
- -
Type
-
- [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` -
+ +
Description
+
+ +A description to describe the purpose of the map. + +
+ +
Type
+
+ +`string` + +
--- -#### `suggestWords` {#languagesetting-suggestwords} +#### `insDel` {#costmapdefswap-insdel}
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. + +
+ +
Type
+
+ +`number` + +
--- -#### `words` {#languagesetting-words} +#### `map` {#costmapdefswap-map}
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +The set of substrings to map, these are generally single character strings. + +Multiple sets can be defined by using a `|` to separate them. + +Example: `"eéê|aåá"` contains two different sets. + +To add a multi-character substring use `()`. + +Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`. + +- To match the beginning of a word, use `^`: `"(^I)""`. +- To match the end of a word, use `$`: `"(e$)(ing$)"`. + +
+ +
Type
+
+ +`string` + +
--- -## LocaleId {#localeid} +#### `penalty` {#costmapdefswap-penalty}
- -
Description
-
- This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Add a penalty to the final cost. +This is used to discourage certain suggestions. + +Example: +```yaml +# Match adding/removing `-` to the end of a word. +map: "$(-$)" +replace: 50 +penalty: 100 +``` + +This makes adding a `-` to the end of a word more expensive. + +Think of it as taking the toll way for speed but getting the bill later. + +
+ +
Type
+
+ +`number` + +
--- -## MatchingFileType {#matchingfiletype} +#### `replace` {#costmapdefswap-replace}
- -
Type
-
- [`LanguageId`](#languageid)
[`LanguageId`](#languageid)`[]` -
+ +
Description
+
+ +The cost to replace of of the substrings in the map with another substring in the map. +Example: Map['a', 'i'] +This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +#### `swap` {#costmapdefswap-swap} + +
+ +
Description
+
+ +The cost to swap two adjacent substrings found in the map. +Example: Map['e', 'i'] +This represents the cost to change `ei` to `ie` or the reverse. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +## CustomDictionaryPath {#customdictionarypath} + +
+ +
Description
+
+ +A File System Path to a dictionary file. + +
+ +
Type
+
+ +[`FsDictionaryPath`](#fsdictionarypath) + +
+
+ +--- + +## CustomDictionaryScope {#customdictionaryscope} + +
+ +
Description
+
+ +Specifies the scope of a dictionary. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## DictionaryDefinition {#dictionarydefinition} + +
+ +
Type
+
+ +[`DictionaryDefinitionPreferred`](#dictionarydefinitionpreferred)
[`DictionaryDefinitionCustom`](#dictionarydefinitioncustom)
[`DictionaryDefinitionAugmented`](#dictionarydefinitionaugmented)
[`DictionaryDefinitionInline`](#dictionarydefinitioninline)
[`DictionaryDefinitionAlternate`](#dictionarydefinitionalternate) + +
+
+ +## DictionaryDefinitionAlternate + +| Field | Type | Description | +| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | +| [description](#dictionarydefinitionalternate-description) | `string` | Optional description. | +| [file](#dictionarydefinitionalternate-file) | [`DictionaryPath`](#dictionarypath) | Path to the file, only for legacy dictionary definitions. | +| [name](#dictionarydefinitionalternate-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionalternate-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitionalternate-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionalternate-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionalternate-usecompounds) | `boolean` | Use Compounds. | + +### DictionaryDefinitionAlternate Fields + +--- + +#### `description` {#dictionarydefinitionalternate-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `file` {#dictionarydefinitionalternate-file} + +
+ +
Description
+
+ +Path to the file, only for legacy dictionary definitions. + +
+ +
Type
+
+ +[`DictionaryPath`](#dictionarypath) + +
+
+ +--- + +#### `name` {#dictionarydefinitionalternate-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitionalternate-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `repMap` {#dictionarydefinitionalternate-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `type` {#dictionarydefinitionalternate-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitionalternate-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +## DictionaryDefinitionAugmented + +| Field | Type | Description | +| ----------------------------------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------- | +| [description](#dictionarydefinitionaugmented-description) | `string` | Optional description. | +| [dictionaryInformation](#dictionarydefinitionaugmented-dictionaryinformation) | [`DictionaryInformation`](#dictionaryinformation) | | +| [name](#dictionarydefinitionaugmented-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionaugmented-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitionaugmented-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | +| [repMap](#dictionarydefinitionaugmented-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionaugmented-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionaugmented-usecompounds) | `boolean` | Use Compounds. | + +### DictionaryDefinitionAugmented Fields + +--- + +#### `description` {#dictionarydefinitionaugmented-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `dictionaryInformation` {#dictionarydefinitionaugmented-dictionaryinformation} + +
+ +
Type
+
+ +[`DictionaryInformation`](#dictionaryinformation) + +
+
+ +--- + +#### `name` {#dictionarydefinitionaugmented-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitionaugmented-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `path` {#dictionarydefinitionaugmented-path} + +
+ +
Description
+
+ +Path to the file. + +
+ +
Type
+
+ +[`DictionaryPath`](#dictionarypath) + +
+
+ +--- + +#### `repMap` {#dictionarydefinitionaugmented-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `type` {#dictionarydefinitionaugmented-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitionaugmented-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +## DictionaryDefinitionCustom + +| Field | Type | Description | +| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | +| [addWords](#dictionarydefinitioncustom-addwords) | `boolean` | When `true`, let's the spell checker know that words can be added to this dictionary. | +| [description](#dictionarydefinitioncustom-description) | `string` | Optional description. | +| [name](#dictionarydefinitioncustom-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioncustom-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitioncustom-path) | [`CustomDictionaryPath`](#customdictionarypath) | Path to custom dictionary text file. | +| [repMap](#dictionarydefinitioncustom-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [scope](#dictionarydefinitioncustom-scope) | [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` | Defines the scope for when words will be added to the dictionary. | +| [type](#dictionarydefinitioncustom-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioncustom-usecompounds) | `boolean` | Use Compounds. | + +### DictionaryDefinitionCustom Fields + +--- + +#### `addWords` {#dictionarydefinitioncustom-addwords} + +
+ +
Description
+
+ +When `true`, let's the spell checker know that words can be added to this dictionary. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `description` {#dictionarydefinitioncustom-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `name` {#dictionarydefinitioncustom-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitioncustom-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `path` {#dictionarydefinitioncustom-path} + +
+ +
Description
+
+ +Path to custom dictionary text file. + +
+ +
Type
+
+ +[`CustomDictionaryPath`](#customdictionarypath) + +
+
+ +--- + +#### `repMap` {#dictionarydefinitioncustom-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `scope` {#dictionarydefinitioncustom-scope} + +
+ +
Description
+
+ +Defines the scope for when words will be added to the dictionary. + +Scope values: `user`, `workspace`, `folder`. + +
+ +
Type
+
+ +[`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` + +
+
+ +--- + +#### `type` {#dictionarydefinitioncustom-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitioncustom-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +## DictionaryDefinitionInline {#dictionarydefinitioninline} + +
+ +
Description
+
+ +Inline Dictionary Definitions + +
+ +
Type
+
+ +[`DictionaryDefinitionInlineWords`](#dictionarydefinitioninlinewords)
[`DictionaryDefinitionInlineIgnoreWords`](#dictionarydefinitioninlineignorewords)
[`DictionaryDefinitionInlineFlagWords`](#dictionarydefinitioninlineflagwords) + +
+
+ +## DictionaryDefinitionInlineFlagWords + +| Field | Type | Description | +| ----------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [description](#dictionarydefinitioninlineflagwords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlineflagwords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlineflagwords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlineflagwords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlineflagwords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlineflagwords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlineflagwords-suggestwords) | `string``[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlineflagwords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlineflagwords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlineflagwords-words) | `string``[]` | List of words to be considered correct. | + +### DictionaryDefinitionInlineFlagWords Fields + +--- + +#### `description` {#dictionarydefinitioninlineflagwords-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `flagWords` {#dictionarydefinitioninlineflagwords-flagwords} + +
+ +
Description
+
+ +List of words to always be considered incorrect. Words found in `flagWords` override `words`. + +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` + +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `ignoreWords` {#dictionarydefinitioninlineflagwords-ignorewords} + +
+ +
Description
+
+ +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `name` {#dictionarydefinitioninlineflagwords-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitioninlineflagwords-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `repMap` {#dictionarydefinitioninlineflagwords-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `suggestWords` {#dictionarydefinitioninlineflagwords-suggestwords} + +
+ +
Description
+
+ +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. + +Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `type` {#dictionarydefinitioninlineflagwords-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitioninlineflagwords-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `words` {#dictionarydefinitioninlineflagwords-words} + +
+ +
Description
+
+ +List of words to be considered correct. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +## DictionaryDefinitionInlineIgnoreWords + +| Field | Type | Description | +| ------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [description](#dictionarydefinitioninlineignorewords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlineignorewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlineignorewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlineignorewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlineignorewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlineignorewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlineignorewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlineignorewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlineignorewords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlineignorewords-words) | `string``[]` | List of words to be considered correct. | + +### DictionaryDefinitionInlineIgnoreWords Fields + +--- + +#### `description` {#dictionarydefinitioninlineignorewords-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `flagWords` {#dictionarydefinitioninlineignorewords-flagwords} + +
+ +
Description
+
+ +List of words to always be considered incorrect. Words found in `flagWords` override `words`. + +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` + +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `ignoreWords` {#dictionarydefinitioninlineignorewords-ignorewords} + +
+ +
Description
+
+ +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `name` {#dictionarydefinitioninlineignorewords-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitioninlineignorewords-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `repMap` {#dictionarydefinitioninlineignorewords-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `suggestWords` {#dictionarydefinitioninlineignorewords-suggestwords} + +
+ +
Description
+
+ +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. + +Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `type` {#dictionarydefinitioninlineignorewords-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitioninlineignorewords-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `words` {#dictionarydefinitioninlineignorewords-words} + +
+ +
Description
+
+ +List of words to be considered correct. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +## DictionaryDefinitionInlineWords + +| Field | Type | Description | +| ------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [description](#dictionarydefinitioninlinewords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlinewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlinewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlinewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlinewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlinewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlinewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlinewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlinewords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlinewords-words) | `string``[]` | List of words to be considered correct. | + +### DictionaryDefinitionInlineWords Fields + +--- + +#### `description` {#dictionarydefinitioninlinewords-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `flagWords` {#dictionarydefinitioninlinewords-flagwords} + +
+ +
Description
+
+ +List of words to always be considered incorrect. Words found in `flagWords` override `words`. + +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` + +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `ignoreWords` {#dictionarydefinitioninlinewords-ignorewords} + +
+ +
Description
+
+ +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `name` {#dictionarydefinitioninlinewords-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitioninlinewords-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `repMap` {#dictionarydefinitioninlinewords-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `suggestWords` {#dictionarydefinitioninlinewords-suggestwords} + +
+ +
Description
+
+ +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. + +Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `type` {#dictionarydefinitioninlinewords-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitioninlinewords-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `words` {#dictionarydefinitioninlinewords-words} + +
+ +
Description
+
+ +List of words to be considered correct. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +## DictionaryDefinitionPreferred + +| Field | Type | Description | +| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | +| [description](#dictionarydefinitionpreferred-description) | `string` | Optional description. | +| [name](#dictionarydefinitionpreferred-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionpreferred-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitionpreferred-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | +| [repMap](#dictionarydefinitionpreferred-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionpreferred-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionpreferred-usecompounds) | `boolean` | Use Compounds. | + +### DictionaryDefinitionPreferred Fields + +--- + +#### `description` {#dictionarydefinitionpreferred-description} + +
+ +
Description
+
+ +Optional description. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `name` {#dictionarydefinitionpreferred-name} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +#### `noSuggest` {#dictionarydefinitionpreferred-nosuggest} + +
+ +
Description
+
+ +Indicate that suggestions should not come from this dictionary. +Words in this dictionary are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +this dictionary, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `path` {#dictionarydefinitionpreferred-path} + +
+ +
Description
+
+ +Path to the file. + +
+ +
Type
+
+ +[`DictionaryPath`](#dictionarypath) + +
+
+ +--- + +#### `repMap` {#dictionarydefinitionpreferred-repmap} + +
+ +
Description
+
+ +Replacement pairs. + +
+ +
Type
+
+ +[`ReplaceMap`](#replacemap) + +
+
+ +--- + +#### `type` {#dictionarydefinitionpreferred-type} + +
+ +
Description
+
+ +Type of file: +- S - single word per line, +- W - each line can contain one or more words separated by space, +- C - each line is treated like code (Camel Case is allowed). + +Default is S. + +C is the slowest to load due to the need to split each line based upon code splitting rules. + +
+ +
Type
+
+ +[`DictionaryFileTypes`](#dictionaryfiletypes) + +
+
+ +--- + +#### `useCompounds` {#dictionarydefinitionpreferred-usecompounds} + +
+ +
Description
+
+ +Use Compounds. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +## DictionaryFileTypes {#dictionaryfiletypes} + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## DictionaryId {#dictionaryid} + +
+ +
Description
+
+ +This is the name of a dictionary. + +Name Format: +- Must contain at least 1 number or letter. +- Spaces are allowed. +- Leading and trailing space will be removed. +- Names ARE case-sensitive. +- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. + +
+ +
Type
+
+ +`string` + +
+
+ +## DictionaryInformation + +| Field | Type | Description | +| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| [accents](#dictionaryinformation-accents) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The accent characters. | +| [adjustments](#dictionaryinformation-adjustments) | [`PatternAdjustment`](#patternadjustment)`[]` | A collection of patterns to test against the suggested words. | +| [alphabet](#dictionaryinformation-alphabet) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The alphabet to use. | +| [costs](#dictionaryinformation-costs) | [`EditCosts`](#editcosts) | Define edit costs. | +| [hunspellInformation](#dictionaryinformation-hunspellinformation) | [`HunspellInformation`](#hunspellinformation) | Used by dictionary authors | +| [ignore](#dictionaryinformation-ignore) | [`CharacterSet`](#characterset) | An optional set of characters that can possibly be removed from a word before | +| [locale](#dictionaryinformation-locale) | `string` | The locale of the dictionary. | +| [suggestionEditCosts](#dictionaryinformation-suggestioneditcosts) | [`SuggestionCostsDefs`](#suggestioncostsdefs) | Used in making suggestions. The lower the value, the more likely the suggestion | + +### DictionaryInformation Fields + +--- + +#### `accents` {#dictionaryinformation-accents} + +
+ +
Description
+
+ +The accent characters. + +Default: `"\u0300-\u0341"` + +
+ +
Type
+
+ +[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` + +
+
+ +--- + +#### `adjustments` {#dictionaryinformation-adjustments} + +
+ +
Description
+
+ +A collection of patterns to test against the suggested words. +If the word matches the pattern, then the penalty is applied. + +
+ +
Type
+
+ +[`PatternAdjustment`](#patternadjustment)`[]` + +
+
+ +--- + +#### `alphabet` {#dictionaryinformation-alphabet} + +
+ +
Description
+
+ +The alphabet to use. + +
+ +
Type
+
+ +[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` + +
+
+ +--- + +#### `costs` {#dictionaryinformation-costs} + +
+ +
Description
+
+ +Define edit costs. + +
+ +
Type
+
+ +[`EditCosts`](#editcosts) + +
+
+ +--- + +#### `hunspellInformation` {#dictionaryinformation-hunspellinformation} + +
+ +
Description
+
+ +Used by dictionary authors + +
+ +
Type
+
+ +[`HunspellInformation`](#hunspellinformation) + +
+
+ +--- + +#### `ignore` {#dictionaryinformation-ignore} + +
+ +
Description
+
+ +An optional set of characters that can possibly be removed from a word before +checking it. + +This is useful in languages like Arabic where Harakat accents are optional. + +Note: All matching characters are removed or none. Partial removal is not supported. + +
+ +
Type
+
+ +[`CharacterSet`](#characterset) + +
+
+ +--- + +#### `locale` {#dictionaryinformation-locale} + +
+ +
Description
+
+ +The locale of the dictionary. +Example: `nl,nl-be` + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `suggestionEditCosts` {#dictionaryinformation-suggestioneditcosts} + +
+ +
Description
+
+ +Used in making suggestions. The lower the value, the more likely the suggestion +will be near the top of the suggestion list. + +
+ +
Type
+
+ +[`SuggestionCostsDefs`](#suggestioncostsdefs) + +
+
+ +--- + +## DictionaryNegRef {#dictionarynegref} + +
+ +
Description
+
+ +This a negative reference to a named dictionary. + +It is used to exclude or include a dictionary by name. + +The reference starts with 1 or more `!`. +- `!` - Used to exclude the dictionary matching ``. +- `!!` - Used to re-include a dictionary matching ``. + Overrides `!`. +- `!!!` - Used to exclude a dictionary matching ``. + Overrides `!!`. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## DictionaryPath {#dictionarypath} + +
+ +
Description
+
+ +A File System Path to a dictionary file. +Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$` + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## DictionaryRef {#dictionaryref} + +
+ +
Description
+
+ +This a reference to a named dictionary. +It is expected to match the name of a dictionary. + +
+ +
Type
+
+ +[`DictionaryId`](#dictionaryid) + +
+
+ +--- + +## DictionaryReference {#dictionaryreference} + +
+ +
Description
+
+ +Reference to a dictionary by name. +One of: +- [DictionaryRef](#dictionaryref) +- [DictionaryNegRef](#dictionarynegref) + +
+ +
Type
+
+ +[`DictionaryRef`](#dictionaryref)
[`DictionaryNegRef`](#dictionarynegref) + +
+
+ +## EditCosts + +| Field | Type | Description | +| --------------------------------------------------- | -------- | ---------------------------------------------------------------- | +| [accentCosts](#editcosts-accentcosts) | `number` | The cost to add / remove an accent | +| [baseCost](#editcosts-basecost) | `number` | This is the base cost for making an edit. | +| [capsCosts](#editcosts-capscosts) | `number` | The cost to change capitalization. | +| [firstLetterPenalty](#editcosts-firstletterpenalty) | `number` | The extra cost incurred for changing the first letter of a word. | +| [nonAlphabetCosts](#editcosts-nonalphabetcosts) | `number` | This is the cost for characters not in the alphabet. | + +### EditCosts Fields + +--- + +#### `accentCosts` {#editcosts-accentcosts} + +
+ +
Description
+
+ +The cost to add / remove an accent +This should be very cheap, it helps with fixing accent issues. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +#### `baseCost` {#editcosts-basecost} + +
+ +
Description
+
+ +This is the base cost for making an edit. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +#### `capsCosts` {#editcosts-capscosts} + +
+ +
Description
+
+ +The cost to change capitalization. +This should be very cheap, it helps with fixing capitalization issues. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +#### `firstLetterPenalty` {#editcosts-firstletterpenalty} + +
+ +
Description
+
+ +The extra cost incurred for changing the first letter of a word. +This value should be less than `100 - baseCost`. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +#### `nonAlphabetCosts` {#editcosts-nonalphabetcosts} + +
+ +
Description
+
+ +This is the cost for characters not in the alphabet. + +
+ +
Type
+
+ +`number` + +
+
+ +--- + +## FSPathResolvable {#fspathresolvable} + +
+ +
Description
+
+ +A File System Path. + +Special Properties: +- `${cwd}` prefix - will be replaced with the current working directory. +- Relative paths are relative to the configuration file. + +
+ +
Type
+
+ +[`FsPath`](#fspath) + +
+
+ +--- + +## FeatureEnableOnly {#featureenableonly} + +
+ +
Type
+
+ +`boolean` + +
+
+ +## Features + +| Field | Type | Description | +| ------------------------------------------------------ | ----------------------------------------- | ------------------------------------------ | +| [weighted-suggestions](#features-weighted-suggestions) | [`FeatureEnableOnly`](#featureenableonly) | Enable/disable using weighted suggestions. | + +### Features Fields + +--- + +#### `weighted-suggestions` {#features-weighted-suggestions} + +
+ +
Description
+
+ +Enable/disable using weighted suggestions. + +
+ +
Type
+
+ +[`FeatureEnableOnly`](#featureenableonly) + +
+
+ +--- + +## FsDictionaryPath {#fsdictionarypath} + +
+ +
Description
+
+ +A File System Path. Relative paths are relative to the configuration file. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## FsPath {#fspath} + +
+ +
Description
+
+ +A File System Path. Relative paths are relative to the configuration file. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## Glob {#glob} + +
+ +
Description
+
+ +These are glob expressions. + +
+ +
Type
+
+ +[`SimpleGlob`](#simpleglob) + +
+
+ +## HunspellInformation + +| Field | Type | Description | +| ----------------------------------- | -------- | --------------------------------------------------- | +| [aff](#hunspellinformation-aff) | `string` | Selected Hunspell AFF content. | +| [costs](#hunspellinformation-costs) | `object` | The costs to apply when using the hunspell settings | + +### HunspellInformation Fields + +--- + +#### `aff` {#hunspellinformation-aff} + +
+ +
Description
+
+ +Selected Hunspell AFF content. +The content must be UTF-8 + +Sections: +- TRY +- MAP +- REP +- KEY +- ICONV +- OCONV + +Example: +```hunspell +# Comment +TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` +MAP aàâäAÀÂÄ +MAP eéèêëEÉÈÊË +MAP iîïyIÎÏY +MAP oôöOÔÖ +MAP (IJ)(IJ) +``` + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `costs` {#hunspellinformation-costs} + +
+ +
Description
+
+ +The costs to apply when using the hunspell settings + +
+ +
Type
+
+ +`object` + +
+
+ +--- + +## LanguageId {#languageid} + +
+ +
Type
+
+ +[`LanguageIdSingle`](#languageidsingle)
[`LanguageIdMultiple`](#languageidmultiple)
[`LanguageIdMultipleNeg`](#languageidmultipleneg) + +
+
+ +--- + +## LanguageIdMultiple {#languageidmultiple} + +
+ +
Description
+
+ +This can be 'typescript,cpp,json,literal haskell', etc. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## LanguageIdMultipleNeg {#languageidmultipleneg} + +
+ +
Description
+
+ +This can be 'typescript,cpp,json,literal haskell', etc. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## LanguageIdSingle {#languageidsingle} + +
+ +
Description
+
+ +This can be '*', 'typescript', 'cpp', 'json', etc. + +
+ +
Type
+
+ +`string` + +
+
+ +## LanguageSetting + +| Field | Type | Description | +| --------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| [allowCompoundWords](#languagesetting-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | +| [caseSensitive](#languagesetting-casesensitive) | `boolean` | Determines if words must match case and accent rules. | +| [description](#languagesetting-description) | `string` | Optional description of configuration. | +| [dictionaries](#languagesetting-dictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | +| [dictionaryDefinitions](#languagesetting-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)`[]` | Define additional available dictionaries. | +| [enabled](#languagesetting-enabled) | `boolean` | Is the spell checker enabled. | +| [flagWords](#languagesetting-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [id](#languagesetting-id) | `string` | Optional identifier. | +| [ignoreRegExpList](#languagesetting-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | +| [ignoreWords](#languagesetting-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [includeRegExpList](#languagesetting-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | +| [languageId](#languagesetting-languageid) | [`MatchingFileType`](#matchingfiletype) | The language id. Ex: "typescript", "html", or "php". "\*" -- will match all languages. | +| [local](#languagesetting-local) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | Deprecated - The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | +| [locale](#languagesetting-locale) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | +| [name](#languagesetting-name) | `string` | Optional name of configuration. | +| [noSuggestDictionaries](#languagesetting-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries that will not be used for suggestions. | +| [patterns](#languagesetting-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | +| [suggestWords](#languagesetting-suggestwords) | `string``[]` | A list of suggested replacements for words. | +| [words](#languagesetting-words) | `string``[]` | List of words to be considered correct. | + +### LanguageSetting Fields + +--- + +#### `allowCompoundWords` {#languagesetting-allowcompoundwords} + +
+ +
Description
+
+ +True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `caseSensitive` {#languagesetting-casesensitive} + +
+ +
Description
+
+ +Determines if words must match case and accent rules. + +- `false` - Case is ignored and accents can be missing on the entire word. + Incorrect accents or partially missing accents will be marked as incorrect. +- `true` - Case and accents are enforced. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `description` {#languagesetting-description} + +
+ +
Description
+
+ +Optional description of configuration. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `dictionaries` {#languagesetting-dictionaries} + +
+ +
Description
+
+ +Optional list of dictionaries to use. Each entry should match the name of the dictionary. + +To remove a dictionary from the list, add `!` before the name. + +For example, `!typescript` will turn off the dictionary with the name `typescript`. + +See the [Dictionaries](https://cspell.org/docs/dictionaries/) +and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. + +
+ +
Type
+
+ +[`DictionaryReference`](#dictionaryreference)`[]` + +
+
+ +--- + +#### `dictionaryDefinitions` {#languagesetting-dictionarydefinitions} + +
+ +
Description
+
+ +Define additional available dictionaries. + +For example, you can use the following to add a custom dictionary: + +```json +"dictionaryDefinitions": [ + { "name": "custom-words", "path": "./custom-words.txt"} +], +"dictionaries": ["custom-words"] +``` + +
+ +
Type
+
+ +[`DictionaryDefinition`](#dictionarydefinition)`[]` + +
+
+ +--- + +#### `enabled` {#languagesetting-enabled} + +
+ +
Description
+
+ +Is the spell checker enabled. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `flagWords` {#languagesetting-flagwords} + +
+ +
Description
+
+ +List of words to always be considered incorrect. Words found in `flagWords` override `words`. + +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` + +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `id` {#languagesetting-id} + +
+ +
Description
+
+ +Optional identifier. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `ignoreRegExpList` {#languagesetting-ignoreregexplist} + +
+ +
Description
+
+ +List of regular expression patterns or pattern names to exclude from spell checking. + +Example: `["href"]` - to exclude html href pattern. + +Regular expressions use JavaScript regular expression syntax. + +Example: to ignore ALL-CAPS words + +JSON +```json +"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] +``` + +YAML +```yaml +ignoreRegExpList: + - >- + /\b[A-Z]+\b/g +``` + +By default, several patterns are excluded. See +[Configuration](https://cspell.org/configuration/patterns) for more details. + +While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). + +
+ +
Type
+
+ +[`RegExpPatternList`](#regexppatternlist) + +
+
+ +--- + +#### `ignoreWords` {#languagesetting-ignorewords} + +
+ +
Description
+
+ +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `includeRegExpList` {#languagesetting-includeregexplist} + +
+ +
Description
+
+ +List of regular expression patterns or defined pattern names to match for spell checking. + +If this property is defined, only text matching the included patterns will be checked. + +While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). + +
+ +
Type
+
+ +[`RegExpPatternList`](#regexppatternlist) + +
+
+ +--- + +#### `languageId` {#languagesetting-languageid} + +
+ +
Description
+
+ +The language id. Ex: "typescript", "html", or "php". "*" -- will match all languages. + +
+ +
Type
+
+ +[`MatchingFileType`](#matchingfiletype) + +
+
+ +--- + +#### `local` {#languagesetting-local} + +
+ +
Description
+
+ +Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. + +
+ +
Type
+
+ +[`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` + +
+
+ +--- + +#### `locale` {#languagesetting-locale} + +
+ +
Description
+
+ +The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. + +
+ +
Type
+
+ +[`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` + +
+
+ +--- + +#### `name` {#languagesetting-name} + +
+ +
Description
+
+ +Optional name of configuration. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `noSuggestDictionaries` {#languagesetting-nosuggestdictionaries} + +
+ +
Description
+
+ +Optional list of dictionaries that will not be used for suggestions. +Words in these dictionaries are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +one of these dictionaries, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +[`DictionaryReference`](#dictionaryreference)`[]` + +
+
+ +--- + +#### `patterns` {#languagesetting-patterns} + +
+ +
Description
+
+ +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. + +For example: + +```javascript +"ignoreRegExpList": ["comments"], +"patterns": [ + { + "name": "comment-single-line", + "pattern": "/#.*/g" + }, + { + "name": "comment-multi-line", + "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" + }, + // You can also combine multiple named patterns into one single named pattern + { + "name": "comments", + "pattern": ["comment-single-line", "comment-multi-line"] + } +] +``` +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. + +
+ +
Type
+
+ +[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` + +
+
+ +--- + +#### `suggestWords` {#languagesetting-suggestwords} + +
+ +
Description
+
+ +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. + +Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `words` {#languagesetting-words} + +
+ +
Description
+
+ +List of words to be considered correct. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +## LocaleId {#localeid} + +
+ +
Description
+
+ +This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +## MatchingFileType {#matchingfiletype} + +
+ +
Type
+
+ +[`LanguageId`](#languageid)
[`LanguageId`](#languageid)`[]` + +
## OverrideSettings @@ -4329,16 +5099,20 @@ format: md #### `allowCompoundWords` {#overridesettings-allowcompoundwords}
- -
Description
-
- True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. -
- -
Type
-
- `boolean` -
+ +
Description
+
+ +True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. + +
+ +
Type
+
+ +`boolean` + +
--- @@ -4346,474 +5120,562 @@ format: md #### `caseSensitive` {#overridesettings-casesensitive}
- -
Description
-
- Determines if words must match case and accent rules. - - - `false` - Case is ignored and accents can be missing on the entire word. - Incorrect accents or partially missing accents will be marked as incorrect. - - `true` - Case and accents are enforced. -
- -
Type
-
- `boolean` -
+ +
Description
+
+ +Determines if words must match case and accent rules. + +- `false` - Case is ignored and accents can be missing on the entire word. + Incorrect accents or partially missing accents will be marked as incorrect. +- `true` - Case and accents are enforced. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `description` {#overridesettings-description} + +
+ +
Description
+
+ +Optional description of configuration. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `dictionaries` {#overridesettings-dictionaries} + +
+ +
Description
+
+ +Optional list of dictionaries to use. Each entry should match the name of the dictionary. + +To remove a dictionary from the list, add `!` before the name. + +For example, `!typescript` will turn off the dictionary with the name `typescript`. + +See the [Dictionaries](https://cspell.org/docs/dictionaries/) +and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. + +
+ +
Type
+
+ +[`DictionaryReference`](#dictionaryreference)`[]` + +
+
+ +--- + +#### `dictionaryDefinitions` {#overridesettings-dictionarydefinitions} + +
+ +
Description
+
+ +Define additional available dictionaries. + +For example, you can use the following to add a custom dictionary: + +```json +"dictionaryDefinitions": [ + { "name": "custom-words", "path": "./custom-words.txt"} +], +"dictionaries": ["custom-words"] +``` + +
+ +
Type
+
+ +[`DictionaryDefinition`](#dictionarydefinition)`[]` + +
+
+ +--- + +#### `enableFiletypes` {#overridesettings-enablefiletypes} + +
+ +
Description
+
+ +Enable / Disable checking file types (languageIds). + +These are in additional to the file types specified by [Settings.enabledLanguageIds](#settings-enabledlanguageids) . +To disable a language, prefix with `!` as in `!json`, + + +**Example: individual file types** + +``` +jsonc // enable checking for jsonc +!json // disable checking for json +kotlin // enable checking for kotlin +``` + +**Example: enable all file types** + +``` +* // enable checking for all file types +!json // except for json +``` + +
+ +
Type
+
+ +[`LanguageIdSingle`](#languageidsingle)`[]` + +
+
+ +--- + +#### `enabled` {#overridesettings-enabled} + +
+ +
Description
+
+ +Is the spell checker enabled. + +
+ +
Type
+
+ +`boolean` + +
+
+ +--- + +#### `enabledFileTypes` {#overridesettings-enabledfiletypes} + +
+ +
Description
+
+ +Enable / Disable checking file types (languageIds). + +This setting replaces: [Settings.enabledLanguageIds](#settings-enabledlanguageids) and [Settings.enableFiletypes](#settings-enablefiletypes) . + +A Value of: +- `true` - enable checking for the file type +- `false` - disable checking for the file type + +A file type of `*` is a wildcard that enables all file types. + +**Example: enable all file types** + +| File Type | Enabled | Comment | +| --------- | ------- | ------- | +| `*` | `true` | Enable all file types. | +| `json` | `false` | Disable checking for json files. | + +
+ +
Type
+
+ +`object` + +
+
+ +--- + +#### `enabledLanguageIds` {#overridesettings-enabledlanguageids} + +
+ +
Description
+
+ +Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. + +
+ +
Type
+
+ +[`LanguageIdSingle`](#languageidsingle)`[]` + +
+
+ +--- + +#### `filename` {#overridesettings-filename} + +
+ +
Description
+
+ +Glob pattern or patterns to match against. + +
+ +
Type
+
+ +[`Glob`](#glob)
[`Glob`](#glob)`[]` + +
+
+ +--- + +#### `flagWords` {#overridesettings-flagwords} + +
+ +
Description
+
+ +List of words to always be considered incorrect. Words found in `flagWords` override `words`. + +Format of `flagWords` +- single word entry - `word` +- with suggestions - `word:suggestion` or `word->suggestion, suggestions` + +Example: +```ts +"flagWords": [ + "color: colour", + "incase: in case, encase", + "canot->cannot", + "cancelled->canceled" +] +``` + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `id` {#overridesettings-id} + +
+ +
Description
+
+ +Optional identifier. + +
+ +
Type
+
+ +`string` + +
+
+ +--- + +#### `ignoreRegExpList` {#overridesettings-ignoreregexplist} + +
+ +
Description
+
+ +List of regular expression patterns or pattern names to exclude from spell checking. + +Example: `["href"]` - to exclude html href pattern. + +Regular expressions use JavaScript regular expression syntax. + +Example: to ignore ALL-CAPS words + +JSON +```json +"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] +``` + +YAML +```yaml +ignoreRegExpList: + - >- + /\b[A-Z]+\b/g +``` + +By default, several patterns are excluded. See +[Configuration](https://cspell.org/configuration/patterns) for more details. + +While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). + +
+ +
Type
+
+ +[`RegExpPatternList`](#regexppatternlist) + +
+
+ +--- + +#### `ignoreWords` {#overridesettings-ignorewords} + +
+ +
Description
+
+ +List of words to be ignored. An ignored word will not show up as an error, even if it is +also in the `flagWords`. + +
+ +
Type
+
+ +`string``[]` + +
+
+ +--- + +#### `includeRegExpList` {#overridesettings-includeregexplist} + +
+ +
Description
+
+ +List of regular expression patterns or defined pattern names to match for spell checking. + +If this property is defined, only text matching the included patterns will be checked. + +While you can create your own patterns, you can also leverage several patterns that are +[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). + +
+ +
Type
+
+ +[`RegExpPatternList`](#regexppatternlist) + +
+
+ +--- + +#### `language` {#overridesettings-language} + +
+ +
Description
+
+ +Sets the locale. + +
+ +
Type
+
+ +[`LocaleId`](#localeid) + +
--- -#### `description` {#overridesettings-description} +#### `languageId` {#overridesettings-languageid}
- -
Description
-
- Optional description of configuration. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `dictionaries` {#overridesettings-dictionaries} +Sets the programming language id to match file type. -
- -
Description
-
- Optional list of dictionaries to use. Each entry should match the name of the dictionary. - - To remove a dictionary from the list, add `!` before the name. - - For example, `!typescript` will turn off the dictionary with the name `typescript`. - - See the [Dictionaries](https://cspell.org/docs/dictionaries/) - and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
-
+
---- +
Type
+
-#### `dictionaryDefinitions` {#overridesettings-dictionarydefinitions} +[`MatchingFileType`](#matchingfiletype) -
- -
Description
-
- Define additional available dictionaries. - - For example, you can use the following to add a custom dictionary: - - ```json - "dictionaryDefinitions": [ - { "name": "custom-words", "path": "./custom-words.txt"} - ], - "dictionaries": ["custom-words"] - ``` -
- -
Type
-
- [`DictionaryDefinition`](#dictionarydefinition)`[]` -
+
--- -#### `enableFiletypes` {#overridesettings-enablefiletypes} +#### `languageSettings` {#overridesettings-languagesettings}
- -
Description
-
- Enable / Disable checking file types (languageIds). - - These are in additional to the file types specified by [Settings.enabledLanguageIds](#settings-enabledlanguageids) . - To disable a language, prefix with `!` as in `!json`, - - - **Example: individual file types** - - ``` - jsonc // enable checking for jsonc - !json // disable checking for json - kotlin // enable checking for kotlin - ``` - - **Example: enable all file types** - - ``` - * // enable checking for all file types - !json // except for json - ``` -
- -
Type
-
- [`LanguageIdSingle`](#languageidsingle)`[]` -
-
---- +
Description
+
-#### `enabled` {#overridesettings-enabled} +Additional settings for individual languages. -
- -
Description
-
- Is the spell checker enabled. -
- -
Type
-
- `boolean` -
-
+See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. ---- +
-#### `enabledFileTypes` {#overridesettings-enabledfiletypes} +
Type
+
-
- -
Description
-
- Enable / Disable checking file types (languageIds). - - This setting replaces: [Settings.enabledLanguageIds](#settings-enabledlanguageids) and [Settings.enableFiletypes](#settings-enablefiletypes) . - - A Value of: - - `true` - enable checking for the file type - - `false` - disable checking for the file type - - A file type of `*` is a wildcard that enables all file types. - - **Example: enable all file types** - - | File Type | Enabled | Comment | - | --------- | ------- | ------- | - | `*` | `true` | Enable all file types. | - | `json` | `false` | Disable checking for json files. | -
- -
Type
-
- `object` -
+[`LanguageSetting`](#languagesetting)`[]` + +
--- -#### `enabledLanguageIds` {#overridesettings-enabledlanguageids} +#### `loadDefaultConfiguration` {#overridesettings-loaddefaultconfiguration}
- -
Description
-
- Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. -
- -
Type
-
- [`LanguageIdSingle`](#languageidsingle)`[]` -
-
---- +
Description
+
-#### `filename` {#overridesettings-filename} +By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` +will prevent ALL default configuration from being loaded. -
- -
Description
-
- Glob pattern or patterns to match against. -
- -
Type
-
- [`Glob`](#glob)
[`Glob`](#glob)`[]` -
-
+
---- +
Type
+
-#### `flagWords` {#overridesettings-flagwords} +`boolean` -
- -
Description
-
- List of words to always be considered incorrect. Words found in `flagWords` override `words`. - - Format of `flagWords` - - single word entry - `word` - - with suggestions - `word:suggestion` or `word->suggestion, suggestions` - - Example: - ```ts - "flagWords": [ - "color: colour", - "incase: in case, encase", - "canot->cannot", - "cancelled->canceled" - ] - ``` -
- -
Type
-
- `string``[]` -
+
--- -#### `id` {#overridesettings-id} +#### `maxDuplicateProblems` {#overridesettings-maxduplicateproblems}
- -
Description
-
- Optional identifier. -
- -
Type
-
- `string` -
-
---- +
Description
+
-#### `ignoreRegExpList` {#overridesettings-ignoreregexplist} +The maximum number of times the same word can be flagged as an error in a file. -
- -
Description
-
- List of regular expression patterns or pattern names to exclude from spell checking. - - Example: `["href"]` - to exclude html href pattern. - - Regular expressions use JavaScript regular expression syntax. - - Example: to ignore ALL-CAPS words - - JSON - ```json - "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"] - ``` - - YAML - ```yaml - ignoreRegExpList: - - >- - /\b[A-Z]+\b/g - ``` - - By default, several patterns are excluded. See - [Configuration](https://cspell.org/configuration/patterns) for more details. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
-
+
---- +
Type
+
-#### `ignoreWords` {#overridesettings-ignorewords} +`number` -
- -
Description
-
- List of words to be ignored. An ignored word will not show up as an error, even if it is - also in the `flagWords`. -
- -
Type
-
- `string``[]` -
+
--- -#### `includeRegExpList` {#overridesettings-includeregexplist} +#### `maxNumberOfProblems` {#overridesettings-maxnumberofproblems}
- -
Description
-
- List of regular expression patterns or defined pattern names to match for spell checking. - - If this property is defined, only text matching the included patterns will be checked. - - While you can create your own patterns, you can also leverage several patterns that are - [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html). -
- -
Type
-
- [`RegExpPatternList`](#regexppatternlist) -
-
---- +
Description
+
-#### `language` {#overridesettings-language} +The maximum number of problems to report in a file. -
- -
Description
-
- Sets the locale. -
- -
Type
-
- [`LocaleId`](#localeid) -
-
+
---- +
Type
+
-#### `languageId` {#overridesettings-languageid} +`number` -
- -
Description
-
- Sets the programming language id to match file type. -
- -
Type
-
- [`MatchingFileType`](#matchingfiletype) -
+
--- -#### `languageSettings` {#overridesettings-languagesettings} +#### `minWordLength` {#overridesettings-minwordlength}
- -
Description
-
- Additional settings for individual languages. - - See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. -
- -
Type
-
- [`LanguageSetting`](#languagesetting)`[]` -
-
---- +
Description
+
-#### `loadDefaultConfiguration` {#overridesettings-loaddefaultconfiguration} +The minimum length of a word before checking it against a dictionary. -
- -
Description
-
- By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` - will prevent ALL default configuration from being loaded. -
- -
Type
-
- `boolean` -
-
+
---- +
Type
+
-#### `maxDuplicateProblems` {#overridesettings-maxduplicateproblems} +`number` -
- -
Description
-
- The maximum number of times the same word can be flagged as an error in a file. -
- -
Type
-
- `number` -
+
--- -#### `maxNumberOfProblems` {#overridesettings-maxnumberofproblems} +#### `name` {#overridesettings-name}
- -
Description
-
- The maximum number of problems to report in a file. -
- -
Type
-
- `number` -
-
---- +
Description
+
-#### `minWordLength` {#overridesettings-minwordlength} +Optional name of configuration. -
- -
Description
-
- The minimum length of a word before checking it against a dictionary. -
- -
Type
-
- `number` -
-
+
---- +
Type
+
-#### `name` {#overridesettings-name} +`string` -
- -
Description
-
- Optional name of configuration. -
- -
Type
-
- `string` -
+
--- @@ -4821,22 +5683,26 @@ format: md #### `noSuggestDictionaries` {#overridesettings-nosuggestdictionaries}
- -
Description
-
- Optional list of dictionaries that will not be used for suggestions. - Words in these dictionaries are considered correct, but will not be - used when making spell correction suggestions. - - Note: if a word is suggested by another dictionary, but found in - one of these dictionaries, it will be removed from the set of - possible suggestions. -
- -
Type
-
- [`DictionaryReference`](#dictionaryreference)`[]` -
+ +
Description
+
+ +Optional list of dictionaries that will not be used for suggestions. +Words in these dictionaries are considered correct, but will not be +used when making spell correction suggestions. + +Note: if a word is suggested by another dictionary, but found in +one of these dictionaries, it will be removed from the set of +possible suggestions. + +
+ +
Type
+
+ +[`DictionaryReference`](#dictionaryreference)`[]` + +
--- @@ -4844,16 +5710,20 @@ format: md #### `numSuggestions` {#overridesettings-numsuggestions}
- -
Description
-
- Number of suggestions to make. -
- -
Type
-
- `number` -
+ +
Description
+
+ +Number of suggestions to make. + +
+ +
Type
+
+ +`number` + +
--- @@ -4861,40 +5731,44 @@ format: md #### `patterns` {#overridesettings-patterns}
- -
Description
-
- Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. - - For example: - - ```javascript - "ignoreRegExpList": ["comments"], - "patterns": [ - { - "name": "comment-single-line", - "pattern": "/#.*/g" - }, - { - "name": "comment-multi-line", - "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" - }, - // You can also combine multiple named patterns into one single named pattern - { - "name": "comments", - "pattern": ["comment-single-line", "comment-multi-line"] - } - ] - ``` - Defines a list of patterns that can be used with the `ignoreRegExpList` and - `includeRegExpList` options. -
- -
Type
-
- [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` -
+ +
Description
+
+ +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. + +For example: + +```javascript +"ignoreRegExpList": ["comments"], +"patterns": [ + { + "name": "comment-single-line", + "pattern": "/#.*/g" + }, + { + "name": "comment-multi-line", + "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g" + }, + // You can also combine multiple named patterns into one single named pattern + { + "name": "comments", + "pattern": ["comment-single-line", "comment-multi-line"] + } +] +``` +Defines a list of patterns that can be used with the `ignoreRegExpList` and +`includeRegExpList` options. + +
+ +
Type
+
+ +[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` + +
--- @@ -4902,16 +5776,20 @@ format: md #### `pnpFiles` {#overridesettings-pnpfiles}
- -
Description
-
- The PnP files to search for. Note: `.mjs` files are not currently supported. -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +The PnP files to search for. Note: `.mjs` files are not currently supported. + +
+ +
Type
+
+ +`string``[]` + +
--- @@ -4919,26 +5797,30 @@ format: md #### `suggestWords` {#overridesettings-suggestwords}
- -
Description
-
- A list of suggested replacements for words. - Suggested words provide a way to make preferred suggestions on word replacements. - To hint at a preferred change, but not to require it. - - Format of `suggestWords` - - Single suggestion (possible auto fix) - - `word: suggestion` - - `word->suggestion` - - Multiple suggestions (not auto fixable) - - `word: first, second, third` - - `word->first, second, third` -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +A list of suggested replacements for words. +Suggested words provide a way to make preferred suggestions on word replacements. +To hint at a preferred change, but not to require it. + +Format of `suggestWords` +- Single suggestion (possible auto fix) + - `word: suggestion` + - `word->suggestion` +- Multiple suggestions (not auto fixable) + - `word: first, second, third` + - `word->first, second, third` + +
+ +
Type
+
+ +`string``[]` + +
--- @@ -4946,20 +5828,24 @@ format: md #### `suggestionNumChanges` {#overridesettings-suggestionnumchanges}
- -
Description
-
- 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. -
- -
Type
-
- `number` -
+ +
Description
+
+ +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. + +
+ +
Type
+
+ +`number` + +
--- @@ -4967,16 +5853,20 @@ format: md #### `suggestionsTimeout` {#overridesettings-suggestionstimeout}
- -
Description
-
- The maximum amount of time in milliseconds to generate suggestions for a word. -
- -
Type
-
- `number` -
+ +
Description
+
+ +The maximum amount of time in milliseconds to generate suggestions for a word. + +
+ +
Type
+
+ +`number` + +
--- @@ -4984,20 +5874,24 @@ format: md #### `usePnP` {#overridesettings-usepnp}
- -
Description
-
- Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading - packages stored in the repository. - - When true, the spell checker will search up the directory structure for the existence - of a PnP file and load it. -
- -
Type
-
- `boolean` -
+ +
Description
+
+ +Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading +packages stored in the repository. + +When true, the spell checker will search up the directory structure for the existence +of a PnP file and load it. + +
+ +
Type
+
+ +`boolean` + +
--- @@ -5005,16 +5899,20 @@ format: md #### `words` {#overridesettings-words}
- -
Description
-
- List of words to be considered correct. -
- -
Type
-
- `string``[]` -
+ +
Description
+
+ +List of words to be considered correct. + +
+ +
Type
+
+ +`string``[]` + +
--- @@ -5022,11 +5920,13 @@ format: md ## Pattern {#pattern}
- -
Type
-
- `string` -
+ +
Type
+
+ +`string` + +
## PatternAdjustment @@ -5044,16 +5944,20 @@ format: md #### `id` {#patternadjustment-id}
- -
Description
-
- Id of the Adjustment, i.e. `short-compound` -
- -
Type
-
- `string` -
+ +
Description
+
+ +Id of the Adjustment, i.e. `short-compound` + +
+ +
Type
+
+ +`string` + +
--- @@ -5061,16 +5965,20 @@ format: md #### `penalty` {#patternadjustment-penalty}
- -
Description
-
- The amount of penalty to apply. -
- -
Type
-
- `number` -
+ +
Description
+
+ +The amount of penalty to apply. + +
+ +
Type
+
+ +`number` + +
--- @@ -5078,16 +5986,20 @@ format: md #### `regexp` {#patternadjustment-regexp}
- -
Description
-
- RegExp pattern to match -
- -
Type
-
- `string` -
+ +
Description
+
+ +RegExp pattern to match + +
+ +
Type
+
+ +`string` + +
--- @@ -5095,16 +6007,20 @@ format: md ## PatternId {#patternid}
- -
Description
-
- This matches the name in a pattern definition. -
- -
Type
-
- `string` -
+ +
Description
+
+ +This matches the name in a pattern definition. + +
+ +
Type
+
+ +`string` + +
--- @@ -5112,16 +6028,20 @@ format: md ## PatternRef {#patternref}
- -
Description
-
- A PatternRef is a Pattern or PatternId. -
- -
Type
-
- [`Pattern`](#pattern)
[`PatternId`](#patternid)
[`PredefinedPatterns`](#predefinedpatterns) -
+ +
Description
+
+ +A PatternRef is a Pattern or PatternId. + +
+ +
Type
+
+ +[`Pattern`](#pattern)
[`PatternId`](#patternid)
[`PredefinedPatterns`](#predefinedpatterns) + +
--- @@ -5129,11 +6049,13 @@ format: md ## PredefinedPatterns {#predefinedpatterns}
- -
Type
-
- `string` -
+ +
Type
+
+ +`string` + +
## RegExpPatternDefinition @@ -5151,16 +6073,20 @@ format: md #### `description` {#regexppatterndefinition-description}
- -
Description
-
- Description of the pattern. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Description of the pattern. + +
+ +
Type
+
+ +`string` + +
--- @@ -5168,17 +6094,21 @@ format: md #### `name` {#regexppatterndefinition-name}
- -
Description
-
- Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. - It is possible to redefine one of the predefined patterns to override its value. -
- -
Type
-
- [`PatternId`](#patternid) -
+ +
Description
+
+ +Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. +It is possible to redefine one of the predefined patterns to override its value. + +
+ +
Type
+
+ +[`PatternId`](#patternid) + +
--- @@ -5186,16 +6116,20 @@ format: md #### `pattern` {#regexppatterndefinition-pattern}
- -
Description
-
- RegExp pattern or array of RegExp patterns. -
- -
Type
-
- [`Pattern`](#pattern)
[`Pattern`](#pattern)`[]` -
+ +
Description
+
+ +RegExp pattern or array of RegExp patterns. + +
+ +
Type
+
+ +[`Pattern`](#pattern)
[`Pattern`](#pattern)`[]` + +
--- @@ -5203,16 +6137,20 @@ format: md ## RegExpPatternList {#regexppatternlist}
- -
Description
-
- A list of pattern names or regular expressions. -
- -
Type
-
- [`PatternRef`](#patternref)`[]` -
+ +
Description
+
+ +A list of pattern names or regular expressions. + +
+ +
Type
+
+ +[`PatternRef`](#patternref)`[]` + +
--- @@ -5220,11 +6158,13 @@ format: md ## ReplaceEntry {#replaceentry}
- -
Type
-
- `string``[]` -
+ +
Type
+
+ +`string``[]` + +
--- @@ -5232,11 +6172,13 @@ format: md ## ReplaceMap {#replacemap}
- -
Type
-
- [`ReplaceEntry`](#replaceentry)`[]` -
+ +
Type
+
+ +[`ReplaceEntry`](#replaceentry)`[]` + +
--- @@ -5244,16 +6186,20 @@ format: md ## ReporterModuleName {#reportermodulename}
- -
Description
-
- The module or path to the the reporter to load. -
- -
Type
-
- `string` -
+ +
Description
+
+ +The module or path to the the reporter to load. + +
+ +
Type
+
+ +`string` + +
--- @@ -5261,16 +6207,20 @@ format: md ## ReporterOptions {#reporteroptions}
- -
Description
-
- Options to send to the reporter. These are defined by the reporter. -
- -
Type
-
- [`Serializable`](#serializable) -
+ +
Description
+
+ +Options to send to the reporter. These are defined by the reporter. + +
+ +
Type
+
+ +[`Serializable`](#serializable) + +
--- @@ -5278,23 +6228,27 @@ format: md ## ReporterSettings {#reportersettings}
- -
Description
-
- Declare a reporter to use. - - `default` - is a special name for the default cli reporter. - - Examples: - - `"default"` - to use the default reporter - - `"@cspell/cspell-json-reporter"` - use the cspell JSON reporter. - - `["@cspell/cspell-json-reporter", { "outFile": "out.json" }]` -
- -
Type
-
- [`ReporterModuleName`](#reportermodulename)
[`ReporterModuleName`](#reportermodulename)`[]`
`Unknown``[]` -
+ +
Description
+
+ +Declare a reporter to use. + +`default` - is a special name for the default cli reporter. + +Examples: +- `"default"` - to use the default reporter +- `"@cspell/cspell-json-reporter"` - use the cspell JSON reporter. +- `["@cspell/cspell-json-reporter", { "outFile": "out.json" }]` + +
+ +
Type
+
+ +[`ReporterModuleName`](#reportermodulename)
[`ReporterModuleName`](#reportermodulename)`[]`
`Unknown``[]` + +
--- @@ -5302,11 +6256,13 @@ format: md ## Serializable {#serializable}
- -
Type
-
- `number`
`string`
`boolean`
`null`
`object` -
+ +
Type
+
+ +`number`
`string`
`boolean`
`null`
`object` + +
--- @@ -5314,16 +6270,20 @@ format: md ## SimpleGlob {#simpleglob}
- -
Description
-
- Simple Glob string, the root will be globRoot. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Simple Glob string, the root will be globRoot. + +
+ +
Type
+
+ +`string` + +
--- @@ -5331,35 +6291,39 @@ format: md ## SuggestionCostMapDef {#suggestioncostmapdef}
- -
Description
-
- A WeightedMapDef enables setting weights for edits between related characters and substrings. - - Multiple groups can be defined using a `|`. - A multi-character substring is defined using `()`. - - For example, in some languages, some letters sound alike. - - ```yaml - map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. - replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. - ``` - - The following could be used to make inserting, removing, or replacing vowels cheaper. - ```yaml - map: 'aeiouy' - insDel: 50 # Make it is cheaper to insert or delete a vowel. - replace: 45 # It is even cheaper to replace one with another. - ``` - - Note: the default edit distance is 100. -
- -
Type
-
- [`CostMapDefReplace`](#costmapdefreplace)
[`CostMapDefInsDel`](#costmapdefinsdel)
[`CostMapDefSwap`](#costmapdefswap) -
+ +
Description
+
+ +A WeightedMapDef enables setting weights for edits between related characters and substrings. + +Multiple groups can be defined using a `|`. +A multi-character substring is defined using `()`. + +For example, in some languages, some letters sound alike. + +```yaml + map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. + replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. +``` + +The following could be used to make inserting, removing, or replacing vowels cheaper. +```yaml + map: 'aeiouy' + insDel: 50 # Make it is cheaper to insert or delete a vowel. + replace: 45 # It is even cheaper to replace one with another. +``` + +Note: the default edit distance is 100. + +
+ +
Type
+
+ +[`CostMapDefReplace`](#costmapdefreplace)
[`CostMapDefInsDel`](#costmapdefinsdel)
[`CostMapDefSwap`](#costmapdefswap) + +
--- @@ -5367,11 +6331,13 @@ format: md ## SuggestionCostsDefs {#suggestioncostsdefs}
- -
Type
-
- [`SuggestionCostMapDef`](#suggestioncostmapdef)`[]` -
+ +
Type
+
+ +[`SuggestionCostMapDef`](#suggestioncostmapdef)`[]` + +
--- @@ -5379,11 +6345,13 @@ format: md ## Version {#version}
- -
Type
-
- [`VersionLatest`](#versionlatest)
[`VersionLegacy`](#versionlegacy) -
+ +
Type
+
+ +[`VersionLatest`](#versionlatest)
[`VersionLegacy`](#versionlegacy) + +
--- @@ -5391,16 +6359,20 @@ format: md ## VersionLatest {#versionlatest}
- -
Description
-
- Configuration File Version. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Configuration File Version. + +
+ +
Type
+
+ +`string` + +
--- @@ -5408,14 +6380,18 @@ format: md ## VersionLegacy {#versionlegacy}
- -
Description
-
- Legacy Configuration File Versions. -
- -
Type
-
- `string` -
+ +
Description
+
+ +Legacy Configuration File Versions. + +
+ +
Type
+
+ +`string` + +
From 15856ca7c0c2cf993fac8bf6e2c570f3b9418ddc Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Fri, 14 Jun 2024 00:35:27 +0200 Subject: [PATCH 2/2] Remove bad "`". --- website/_scripts/extract-properties.mjs | 2 +- website/docs/Configuration/auto_properties.md | 1707 ++++++++++++++--- 2 files changed, 1388 insertions(+), 321 deletions(-) diff --git a/website/_scripts/extract-properties.mjs b/website/_scripts/extract-properties.mjs index a88f99db3788..ba672b85dc2b 100644 --- a/website/_scripts/extract-properties.mjs +++ b/website/_scripts/extract-properties.mjs @@ -142,7 +142,7 @@ function formatEntryType(entry, addFix = '`') { } if (entry.type === 'array' && entry.items) { - return formatEntryType(entry.items, '`') + fix(`[]`); + return formatEntryType(entry.items, '`') + '​' + fix(`[]`); } if (entry.type) { return fix(entry.type); diff --git a/website/docs/Configuration/auto_properties.md b/website/docs/Configuration/auto_properties.md index 696f3e19b61d..3886aa5baa12 100644 --- a/website/docs/Configuration/auto_properties.md +++ b/website/docs/Configuration/auto_properties.md @@ -9,68 +9,73 @@ format: md # CSpell Configuration + + ## Settings -| Field | Type | Description | -| -------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [$schema](#settings--schema) | `string` | Url to JSON Schema | -| [allowCompoundWords](#settings-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | -| [cache](#settings-cache) | [`CacheSettings`](#cachesettings) | Define cache settings. | -| [caseSensitive](#settings-casesensitive) | `boolean` | Determines if words must match case and accent rules. | -| [description](#settings-description) | `string` | Optional description of configuration. | -| [dictionaries](#settings-dictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#settings-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)`[]` | Define additional available dictionaries. | -| [enableFiletypes](#settings-enablefiletypes) | [`LanguageIdSingle`](#languageidsingle)`[]` | Enable / Disable checking file types (languageIds). | -| [enableGlobDot](#settings-enableglobdot) | `boolean` | Enable scanning files and directories beginning with `.` (period). | -| [enabled](#settings-enabled) | `boolean` | Is the spell checker enabled. | -| [enabledFileTypes](#settings-enabledfiletypes) | `object` | Enable / Disable checking file types (languageIds). | -| [enabledLanguageIds](#settings-enabledlanguageids) | [`LanguageIdSingle`](#languageidsingle)`[]` | Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. | -| [failFast](#settings-failfast) | `boolean` | Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks) | -| [features](#settings-features) | [`Features`](#features) | Configure CSpell features. | -| [files](#settings-files) | [`Glob`](#glob)`[]` | Glob patterns of files to be checked. | -| [flagWords](#settings-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [gitignoreRoot](#settings-gitignoreroot) | [`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` | Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. | -| [globRoot](#settings-globroot) | [`FSPathResolvable`](#fspathresolvable) | The root to use for glob patterns found in this configuration. | -| [id](#settings-id) | `string` | Optional identifier. | -| [ignorePaths](#settings-ignorepaths) | [`Glob`](#glob)`[]` | Glob patterns of files to be ignored. | -| [ignoreRegExpList](#settings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | -| [ignoreWords](#settings-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [import](#settings-import) | [`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` | Allows this configuration to inherit configuration for one or more other files. | -| [includeRegExpList](#settings-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | -| [language](#settings-language) | [`LocaleId`](#localeid) | Current active spelling language. This specifies the language locale to use in choosing the | -| [languageId](#settings-languageid) | [`MatchingFileType`](#matchingfiletype) | Forces the spell checker to assume a give language id. Used mainly as an Override. | -| [languageSettings](#settings-languagesettings) | [`LanguageSetting`](#languagesetting)`[]` | Additional settings for individual languages. | -| [loadDefaultConfiguration](#settings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` | -| [maxDuplicateProblems](#settings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. | -| [maxNumberOfProblems](#settings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. | -| [minWordLength](#settings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. | -| [name](#settings-name) | `string` | Optional name of configuration. | -| [noConfigSearch](#settings-noconfigsearch) | `boolean` | Prevents searching for local configuration when checking individual documents. | -| [noSuggestDictionaries](#settings-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries that will not be used for suggestions. | -| [numSuggestions](#settings-numsuggestions) | `number` | Number of suggestions to make. | -| [overrides](#settings-overrides) | [`OverrideSettings`](#overridesettings)`[]` | Overrides are used to apply settings for specific files in your project. | -| [patterns](#settings-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | -| [pnpFiles](#settings-pnpfiles) | `string``[]` | The PnP files to search for. Note: `.mjs` files are not currently supported. | -| [readonly](#settings-readonly) | `boolean` | Indicate that the configuration file should not be modified. | -| [reporters](#settings-reporters) | [`ReporterSettings`](#reportersettings)`[]` | Define which reports to use. | -| [showStatus](#settings-showstatus) | `boolean` | Show status. | -| [spellCheckDelayMs](#settings-spellcheckdelayms) | `number` | Delay in ms after a document has changed before checking it for spelling errors. | -| [suggestWords](#settings-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [suggestionNumChanges](#settings-suggestionnumchanges) | `number` | The maximum number of changes allowed on a word to be considered a suggestions. | -| [suggestionsTimeout](#settings-suggestionstimeout) | `number` | The maximum amount of time in milliseconds to generate suggestions for a word. | -| [useGitignore](#settings-usegitignore) | `boolean` | Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. | -| [usePnP](#settings-usepnp) | `boolean` | Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading | -| [userWords](#settings-userwords) | `string``[]` | Words to add to global dictionary -- should only be in the user config file. | -| [validateDirectives](#settings-validatedirectives) | `boolean` | Verify that the in-document directives are correct. | -| [version](#settings-version) | [`Version`](#version) | Configuration format version of the settings file. | -| [words](#settings-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [$schema](#settings--schema) | `string` | Url to JSON Schema | +| [allowCompoundWords](#settings-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | +| [cache](#settings-cache) | [`CacheSettings`](#cachesettings) | Define cache settings. | +| [caseSensitive](#settings-casesensitive) | `boolean` | Determines if words must match case and accent rules. | +| [description](#settings-description) | `string` | Optional description of configuration. | +| [dictionaries](#settings-dictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | +| [dictionaryDefinitions](#settings-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)​`[]` | Define additional available dictionaries. | +| [enableFiletypes](#settings-enablefiletypes) | [`LanguageIdSingle`](#languageidsingle)​`[]` | Enable / Disable checking file types (languageIds). | +| [enableGlobDot](#settings-enableglobdot) | `boolean` | Enable scanning files and directories beginning with `.` (period). | +| [enabled](#settings-enabled) | `boolean` | Is the spell checker enabled. | +| [enabledFileTypes](#settings-enabledfiletypes) | `object` | Enable / Disable checking file types (languageIds). | +| [enabledLanguageIds](#settings-enabledlanguageids) | [`LanguageIdSingle`](#languageidsingle)​`[]` | Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. | +| [failFast](#settings-failfast) | `boolean` | Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks) | +| [features](#settings-features) | [`Features`](#features) | Configure CSpell features. | +| [files](#settings-files) | [`Glob`](#glob)​`[]` | Glob patterns of files to be checked. | +| [flagWords](#settings-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [gitignoreRoot](#settings-gitignoreroot) | [`FsPath`](#fspath)
[`FsPath`](#fspath)​`[]` | Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. | +| [globRoot](#settings-globroot) | [`FSPathResolvable`](#fspathresolvable) | The root to use for glob patterns found in this configuration. | +| [id](#settings-id) | `string` | Optional identifier. | +| [ignorePaths](#settings-ignorepaths) | [`Glob`](#glob)​`[]` | Glob patterns of files to be ignored. | +| [ignoreRegExpList](#settings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | +| [ignoreWords](#settings-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [import](#settings-import) | [`FsPath`](#fspath)
[`FsPath`](#fspath)​`[]` | Allows this configuration to inherit configuration for one or more other files. | +| [includeRegExpList](#settings-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | +| [language](#settings-language) | [`LocaleId`](#localeid) | Current active spelling language. This specifies the language locale to use in choosing the | +| [languageId](#settings-languageid) | [`MatchingFileType`](#matchingfiletype) | Forces the spell checker to assume a give language id. Used mainly as an Override. | +| [languageSettings](#settings-languagesettings) | [`LanguageSetting`](#languagesetting)​`[]` | Additional settings for individual languages. | +| [loadDefaultConfiguration](#settings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` | +| [maxDuplicateProblems](#settings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. | +| [maxNumberOfProblems](#settings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. | +| [minWordLength](#settings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. | +| [name](#settings-name) | `string` | Optional name of configuration. | +| [noConfigSearch](#settings-noconfigsearch) | `boolean` | Prevents searching for local configuration when checking individual documents. | +| [noSuggestDictionaries](#settings-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries that will not be used for suggestions. | +| [numSuggestions](#settings-numsuggestions) | `number` | Number of suggestions to make. | +| [overrides](#settings-overrides) | [`OverrideSettings`](#overridesettings)​`[]` | Overrides are used to apply settings for specific files in your project. | +| [patterns](#settings-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)​`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | +| [pnpFiles](#settings-pnpfiles) | `string`​`[]` | The PnP files to search for. Note: `.mjs` files are not currently supported. | +| [readonly](#settings-readonly) | `boolean` | Indicate that the configuration file should not be modified. | +| [reporters](#settings-reporters) | [`ReporterSettings`](#reportersettings)​`[]` | Define which reports to use. | +| [showStatus](#settings-showstatus) | `boolean` | Show status. | +| [spellCheckDelayMs](#settings-spellcheckdelayms) | `number` | Delay in ms after a document has changed before checking it for spelling errors. | +| [suggestWords](#settings-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [suggestionNumChanges](#settings-suggestionnumchanges) | `number` | The maximum number of changes allowed on a word to be considered a suggestions. | +| [suggestionsTimeout](#settings-suggestionstimeout) | `number` | The maximum amount of time in milliseconds to generate suggestions for a word. | +| [useGitignore](#settings-usegitignore) | `boolean` | Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. | +| [usePnP](#settings-usepnp) | `boolean` | Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading | +| [userWords](#settings-userwords) | `string`​`[]` | Words to add to global dictionary -- should only be in the user config file. | +| [validateDirectives](#settings-validatedirectives) | `boolean` | Verify that the in-document directives are correct. | +| [version](#settings-version) | [`Version`](#version) | Configuration format version of the settings file. | +| [words](#settings-words) | `string`​`[]` | List of words to be considered correct. | + ### Settings Fields + --- #### `$schema` {#settings--schema} +
Description
@@ -88,10 +93,14 @@ Url to JSON Schema
+ + + --- #### `allowCompoundWords` {#settings-allowcompoundwords} +
Description
@@ -109,10 +118,14 @@ True to enable compound word checking. See [Case Sensitivity](https://cspell.org
+ + + --- #### `cache` {#settings-cache} +
Description
@@ -130,10 +143,14 @@ Define cache settings.
+ + + --- #### `caseSensitive` {#settings-casesensitive} +
Description
@@ -155,10 +172,14 @@ Determines if words must match case and accent rules.
+ + + --- #### `description` {#settings-description} +
Description
@@ -176,10 +197,14 @@ Optional description of configuration.
+ + + --- #### `dictionaries` {#settings-dictionaries} +
Description
@@ -199,15 +224,19 @@ and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `dictionaryDefinitions` {#settings-dictionarydefinitions} +
Description
@@ -229,15 +258,19 @@ For example, you can use the following to add a custom dictionary:
Type
-[`DictionaryDefinition`](#dictionarydefinition)`[]` +[`DictionaryDefinition`](#dictionarydefinition)​`[]`
+ + + --- #### `enableFiletypes` {#settings-enablefiletypes} +
Description
@@ -269,15 +302,19 @@ kotlin // enable checking for kotlin
Type
-[`LanguageIdSingle`](#languageidsingle)`[]` +[`LanguageIdSingle`](#languageidsingle)​`[]`
+ + + --- #### `enableGlobDot` {#settings-enableglobdot} +
Description
@@ -297,10 +334,14 @@ By default, CSpell does not scan `hidden` files.
+ + + --- #### `enabled` {#settings-enabled} +
Description
@@ -318,10 +359,14 @@ Is the spell checker enabled.
+ + + --- #### `enabledFileTypes` {#settings-enabledfiletypes} +
Description
@@ -354,10 +399,14 @@ A file type of `*` is a wildcard that enables all file types.
+ + + --- #### `enabledLanguageIds` {#settings-enabledlanguageids} +
Description
@@ -370,15 +419,19 @@ Specify a list of file types to spell check. It is better to use [Settings.enab
Type
-[`LanguageIdSingle`](#languageidsingle)`[]` +[`LanguageIdSingle`](#languageidsingle)​`[]`
+ + + --- #### `failFast` {#settings-failfast} +
Description
@@ -396,10 +449,14 @@ Exit with non-zero code as soon as an issue/error is encountered (useful for CI
+ + + --- #### `features` {#settings-features} +
Description
@@ -417,10 +474,14 @@ Configure CSpell features.
+ + + --- #### `files` {#settings-files} +
Description
@@ -435,15 +496,19 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi
Type
-[`Glob`](#glob)`[]` +[`Glob`](#glob)​`[]`
+ + + --- #### `flagWords` {#settings-flagwords} +
Description
@@ -470,15 +535,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `gitignoreRoot` {#settings-gitignoreroot} +
Description
@@ -491,15 +560,19 @@ Tells the spell checker to stop searching for `.gitignore` files when it reaches
Type
-[`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` +[`FsPath`](#fspath)
[`FsPath`](#fspath)​`[]`
+ + + --- #### `globRoot` {#settings-globroot} +
Description
@@ -528,10 +601,14 @@ Special Values:
+ + + --- #### `id` {#settings-id} +
Description
@@ -549,10 +626,14 @@ Optional identifier.
+ + + --- #### `ignorePaths` {#settings-ignorepaths} +
Description
@@ -567,15 +648,19 @@ Glob patterns are relative to the `globRoot` of the configuration file that defi
Type
-[`Glob`](#glob)`[]` +[`Glob`](#glob)​`[]`
+ + + --- #### `ignoreRegExpList` {#settings-ignoreregexplist} +
Description
@@ -617,10 +702,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `ignoreWords` {#settings-ignorewords} +
Description
@@ -634,15 +723,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `import` {#settings-import} +
Description
@@ -657,15 +750,19 @@ See [Importing / Extending Configuration](https://cspell.org/configuration/impor
Type
-[`FsPath`](#fspath)
[`FsPath`](#fspath)`[]` +[`FsPath`](#fspath)
[`FsPath`](#fspath)​`[]`
+ + + --- #### `includeRegExpList` {#settings-includeregexplist} +
Description
@@ -688,10 +785,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `language` {#settings-language} +
Description
@@ -715,10 +816,14 @@ For example:
+ + + --- #### `languageId` {#settings-languageid} +
Description
@@ -736,10 +841,14 @@ Forces the spell checker to assume a give language id. Used mainly as an Overrid
+ + + --- #### `languageSettings` {#settings-languagesettings} +
Description
@@ -754,15 +863,19 @@ See [Language Settings](https://cspell.org/configuration/language-settings/) for
Type
-[`LanguageSetting`](#languagesetting)`[]` +[`LanguageSetting`](#languagesetting)​`[]`
+ + + --- #### `loadDefaultConfiguration` {#settings-loaddefaultconfiguration} +
Description
@@ -781,10 +894,14 @@ will prevent ALL default configuration from being loaded.
+ + + --- #### `maxDuplicateProblems` {#settings-maxduplicateproblems} +
Description
@@ -802,10 +919,14 @@ The maximum number of times the same word can be flagged as an error in a file.
+ + + --- #### `maxNumberOfProblems` {#settings-maxnumberofproblems} +
Description
@@ -823,10 +944,14 @@ The maximum number of problems to report in a file.
+ + + --- #### `minWordLength` {#settings-minwordlength} +
Description
@@ -844,10 +969,14 @@ The minimum length of a word before checking it against a dictionary.
+ + + --- #### `name` {#settings-name} +
Description
@@ -865,10 +994,14 @@ Optional name of configuration.
+ + + --- #### `noConfigSearch` {#settings-noconfigsearch} +
Description
@@ -886,10 +1019,14 @@ Prevents searching for local configuration when checking individual documents.
+ + + --- #### `noSuggestDictionaries` {#settings-nosuggestdictionaries} +
Description
@@ -908,15 +1045,19 @@ possible suggestions.
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `numSuggestions` {#settings-numsuggestions} +
Description
@@ -934,10 +1075,14 @@ Number of suggestions to make.
+ + + --- #### `overrides` {#settings-overrides} +
Description
@@ -967,15 +1112,19 @@ For example:
Type
-[`OverrideSettings`](#overridesettings)`[]` +[`OverrideSettings`](#overridesettings)​`[]`
+ + + --- #### `patterns` {#settings-patterns} +
Description
@@ -1012,15 +1161,19 @@ Defines a list of patterns that can be used with the `ignoreRegExpList` and
Type
-[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` +[`RegExpPatternDefinition`](#regexppatterndefinition)​`[]`
+ + + --- #### `pnpFiles` {#settings-pnpfiles} +
Description
@@ -1033,15 +1186,19 @@ The PnP files to search for. Note: `.mjs` files are not currently supported.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `readonly` {#settings-readonly} +
Description
@@ -1061,10 +1218,14 @@ modifying the file to add words and other configuration.
+ + + --- #### `reporters` {#settings-reporters} +
Description
@@ -1084,15 +1245,19 @@ Examples:
Type
-[`ReporterSettings`](#reportersettings)`[]` +[`ReporterSettings`](#reportersettings)​`[]`
+ + + --- #### `showStatus` {#settings-showstatus} +
Description
@@ -1110,10 +1275,14 @@ Show status.
+ + + --- #### `spellCheckDelayMs` {#settings-spellcheckdelayms} +
Description
@@ -1131,10 +1300,14 @@ Delay in ms after a document has changed before checking it for spelling errors.
+ + + --- #### `suggestWords` {#settings-suggestwords} +
Description
@@ -1157,15 +1330,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `suggestionNumChanges` {#settings-suggestionnumchanges} +
Description
@@ -1187,10 +1364,14 @@ Range: between 1 and 5.
+ + + --- #### `suggestionsTimeout` {#settings-suggestionstimeout} +
Description
@@ -1208,10 +1389,14 @@ The maximum amount of time in milliseconds to generate suggestions for a word.
+ + + --- #### `useGitignore` {#settings-usegitignore} +
Description
@@ -1229,10 +1414,14 @@ Tells the spell checker to load `.gitignore` files and skip files that match the
+ + + --- #### `usePnP` {#settings-usepnp} +
Description
@@ -1254,10 +1443,14 @@ of a PnP file and load it.
+ + + --- #### `userWords` {#settings-userwords} +
Description
@@ -1270,15 +1463,19 @@ Words to add to global dictionary -- should only be in the user config file.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `validateDirectives` {#settings-validatedirectives} +
Description
@@ -1296,10 +1493,14 @@ Verify that the in-document directives are correct.
+ + + --- #### `version` {#settings-version} +
Description
@@ -1319,10 +1520,14 @@ This controls how the settings in the configuration file behave.
+ + + --- #### `words` {#settings-words} +
Description
@@ -1335,15 +1540,20 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + + + --- ## CacheFormat {#cacheformat} +
Type
@@ -1354,21 +1564,26 @@ List of words to be considered correct.
+ + ## CacheSettings -| Field | Type | Description | -| --------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------------------------- | -| [cacheFormat](#cachesettings-cacheformat) | [`CacheFormat`](#cacheformat) | Format of the cache file. | -| [cacheLocation](#cachesettings-cachelocation) | [`FSPathResolvable`](#fspathresolvable) | Path to the cache location. Can be a file or a directory. | -| [cacheStrategy](#cachesettings-cachestrategy) | [`CacheStrategy`](#cachestrategy) | Strategy to use for detecting changed files, default: metadata | -| [useCache](#cachesettings-usecache) | `boolean` | Store the results of processed files in order to only operate on the changed ones. | +| Field | Type | Description | +| --- | --- | --- | +| [cacheFormat](#cachesettings-cacheformat) | [`CacheFormat`](#cacheformat) | Format of the cache file. | +| [cacheLocation](#cachesettings-cachelocation) | [`FSPathResolvable`](#fspathresolvable) | Path to the cache location. Can be a file or a directory. | +| [cacheStrategy](#cachesettings-cachestrategy) | [`CacheStrategy`](#cachestrategy) | Strategy to use for detecting changed files, default: metadata | +| [useCache](#cachesettings-usecache) | `boolean` | Store the results of processed files in order to only operate on the changed ones. | + ### CacheSettings Fields + --- #### `cacheFormat` {#cachesettings-cacheformat} +
Description
@@ -1388,10 +1603,14 @@ Format of the cache file.
+ + + --- #### `cacheLocation` {#cachesettings-cachelocation} +
Description
@@ -1414,10 +1633,14 @@ A prefix of `${cwd}` is replaced with the current working directory.
+ + + --- #### `cacheStrategy` {#cachesettings-cachestrategy} +
Description
@@ -1435,10 +1658,14 @@ Strategy to use for detecting changed files, default: metadata
+ + + --- #### `useCache` {#cachesettings-usecache} +
Description
@@ -1456,10 +1683,15 @@ Store the results of processed files in order to only operate on the changed one
+ + + + --- ## CacheStrategy {#cachestrategy} +
Description
@@ -1479,10 +1711,15 @@ The Strategy to use to detect if a file has changed.
+ + + + --- ## CharacterSet {#characterset} +
Description
@@ -1503,20 +1740,25 @@ This is a set of characters that can include `-` or `|`
+ + ## CharacterSetCosts -| Field | Type | Description | -| ------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------- | --- | -| [characters](#charactersetcosts-characters) | [`CharacterSet`](#characterset) | This is a set of characters that can include `-` or ` | ` | -| [cost](#charactersetcosts-cost) | `number` | the cost to insert / delete / replace / swap the characters in a group | -| [penalty](#charactersetcosts-penalty) | `number` | The penalty cost to apply if the accent is used. | +| Field | Type | Description | +| --- | --- | --- | +| [characters](#charactersetcosts-characters) | [`CharacterSet`](#characterset) | This is a set of characters that can include `-` or `|` | +| [cost](#charactersetcosts-cost) | `number` | the cost to insert / delete / replace / swap the characters in a group | +| [penalty](#charactersetcosts-penalty) | `number` | The penalty cost to apply if the accent is used. | + ### CharacterSetCosts Fields + --- #### `characters` {#charactersetcosts-characters} +
Description
@@ -1537,10 +1779,14 @@ This is a set of characters that can include `-` or `|`
+ + + --- #### `cost` {#charactersetcosts-cost} +
Description
@@ -1558,10 +1804,14 @@ the cost to insert / delete / replace / swap the characters in a group
+ + + --- #### `penalty` {#charactersetcosts-penalty} +
Description
@@ -1580,23 +1830,28 @@ This is used to discourage
+ + ## CostMapDefInsDel -| Field | Type | Description | -| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefinsdel-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefinsdel-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefinsdel-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefinsdel-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefinsdel-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefinsdel-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#costmapdefinsdel-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefinsdel-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefinsdel-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefinsdel-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefinsdel-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefinsdel-swap) | `number` | The cost to swap two adjacent substrings found in the map. | + ### CostMapDefInsDel Fields + --- #### `description` {#costmapdefinsdel-description} +
Description
@@ -1614,10 +1869,14 @@ A description to describe the purpose of the map.
---- + + + +--- #### `insDel` {#costmapdefinsdel-insdel} +
Description
@@ -1635,10 +1894,14 @@ The cost to insert/delete one of the substrings in the map. Note: insert/delete
+ + + --- #### `map` {#costmapdefinsdel-map} +
Description
@@ -1667,10 +1930,14 @@ Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.
+ + + --- #### `penalty` {#costmapdefinsdel-penalty} +
Description
@@ -1701,10 +1968,14 @@ Think of it as taking the toll way for speed but getting the bill later.
+ + + --- #### `replace` {#costmapdefinsdel-replace} +
Description
@@ -1724,10 +1995,14 @@ This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the re
+ + + --- #### `swap` {#costmapdefinsdel-swap} +
Description
@@ -1747,23 +2022,28 @@ This represents the cost to change `ei` to `ie` or the reverse.
+ + ## CostMapDefReplace -| Field | Type | Description | -| --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefreplace-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefreplace-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefreplace-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefreplace-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefreplace-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefreplace-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#costmapdefreplace-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefreplace-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefreplace-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefreplace-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefreplace-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefreplace-swap) | `number` | The cost to swap two adjacent substrings found in the map. | + ### CostMapDefReplace Fields + --- #### `description` {#costmapdefreplace-description} +
Description
@@ -1781,10 +2061,14 @@ A description to describe the purpose of the map.
+ + + --- #### `insDel` {#costmapdefreplace-insdel} +
Description
@@ -1802,10 +2086,14 @@ The cost to insert/delete one of the substrings in the map. Note: insert/delete
+ + + --- #### `map` {#costmapdefreplace-map} +
Description
@@ -1834,10 +2122,14 @@ Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.
+ + + --- #### `penalty` {#costmapdefreplace-penalty} +
Description
@@ -1868,10 +2160,14 @@ Think of it as taking the toll way for speed but getting the bill later.
+ + + --- #### `replace` {#costmapdefreplace-replace} +
Description
@@ -1891,10 +2187,14 @@ This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the re
+ + + --- #### `swap` {#costmapdefreplace-swap} +
Description
@@ -1914,23 +2214,28 @@ This represents the cost to change `ei` to `ie` or the reverse.
+ + ## CostMapDefSwap -| Field | Type | Description | -| ------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------ | -| [description](#costmapdefswap-description) | `string` | A description to describe the purpose of the map. | -| [insDel](#costmapdefswap-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | -| [map](#costmapdefswap-map) | `string` | The set of substrings to map, these are generally single character strings. | -| [penalty](#costmapdefswap-penalty) | `number` | Add a penalty to the final cost. | -| [replace](#costmapdefswap-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | -| [swap](#costmapdefswap-swap) | `number` | The cost to swap two adjacent substrings found in the map. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#costmapdefswap-description) | `string` | A description to describe the purpose of the map. | +| [insDel](#costmapdefswap-insdel) | `number` | The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. | +| [map](#costmapdefswap-map) | `string` | The set of substrings to map, these are generally single character strings. | +| [penalty](#costmapdefswap-penalty) | `number` | Add a penalty to the final cost. | +| [replace](#costmapdefswap-replace) | `number` | The cost to replace of of the substrings in the map with another substring in the map. | +| [swap](#costmapdefswap-swap) | `number` | The cost to swap two adjacent substrings found in the map. | + ### CostMapDefSwap Fields + --- #### `description` {#costmapdefswap-description} +
Description
@@ -1948,10 +2253,14 @@ A description to describe the purpose of the map.
+ + + --- #### `insDel` {#costmapdefswap-insdel} +
Description
@@ -1969,10 +2278,14 @@ The cost to insert/delete one of the substrings in the map. Note: insert/delete
+ + + --- #### `map` {#costmapdefswap-map} +
Description
@@ -2001,10 +2314,14 @@ Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.
+ + + --- #### `penalty` {#costmapdefswap-penalty} +
Description
@@ -2035,10 +2352,14 @@ Think of it as taking the toll way for speed but getting the bill later.
+ + + --- #### `replace` {#costmapdefswap-replace} +
Description
@@ -2058,10 +2379,14 @@ This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the re
+ + + --- #### `swap` {#costmapdefswap-swap} +
Description
@@ -2081,10 +2406,15 @@ This represents the cost to change `ei` to `ie` or the reverse.
+ + + + --- ## CustomDictionaryPath {#customdictionarypath} +
Description
@@ -2102,10 +2432,15 @@ A File System Path to a dictionary file.
+ + + + --- ## CustomDictionaryScope {#customdictionaryscope} +
Description
@@ -2123,10 +2458,15 @@ Specifies the scope of a dictionary.
+ + + + --- ## DictionaryDefinition {#dictionarydefinition} +
Type
@@ -2137,24 +2477,29 @@ Specifies the scope of a dictionary.
+ + ## DictionaryDefinitionAlternate -| Field | Type | Description | -| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionalternate-description) | `string` | Optional description. | -| [file](#dictionarydefinitionalternate-file) | [`DictionaryPath`](#dictionarypath) | Path to the file, only for legacy dictionary definitions. | -| [name](#dictionarydefinitionalternate-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionalternate-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitionalternate-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionalternate-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionalternate-usecompounds) | `boolean` | Use Compounds. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitionalternate-description) | `string` | Optional description. | +| [file](#dictionarydefinitionalternate-file) | [`DictionaryPath`](#dictionarypath) | Path to the file, only for legacy dictionary definitions. | +| [name](#dictionarydefinitionalternate-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionalternate-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitionalternate-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionalternate-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionalternate-usecompounds) | `boolean` | Use Compounds. | + ### DictionaryDefinitionAlternate Fields + --- #### `description` {#dictionarydefinitionalternate-description} +
Description
@@ -2172,10 +2517,14 @@ Optional description.
+ + + --- #### `file` {#dictionarydefinitionalternate-file} +
Description
@@ -2193,10 +2542,14 @@ Path to the file, only for legacy dictionary definitions.
+ + + --- #### `name` {#dictionarydefinitionalternate-name} +
Description
@@ -2221,10 +2574,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitionalternate-nosuggest} +
Description
@@ -2248,10 +2605,14 @@ possible suggestions.
+ + + --- #### `repMap` {#dictionarydefinitionalternate-repmap} +
Description
@@ -2269,10 +2630,14 @@ Replacement pairs.
+ + + --- #### `type` {#dictionarydefinitionalternate-type} +
Description
@@ -2297,10 +2662,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitionalternate-usecompounds} +
Description
@@ -2318,25 +2687,30 @@ Use Compounds.
+ + ## DictionaryDefinitionAugmented -| Field | Type | Description | -| ----------------------------------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionaugmented-description) | `string` | Optional description. | -| [dictionaryInformation](#dictionarydefinitionaugmented-dictionaryinformation) | [`DictionaryInformation`](#dictionaryinformation) | | -| [name](#dictionarydefinitionaugmented-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionaugmented-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitionaugmented-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | -| [repMap](#dictionarydefinitionaugmented-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionaugmented-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionaugmented-usecompounds) | `boolean` | Use Compounds. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitionaugmented-description) | `string` | Optional description. | +| [dictionaryInformation](#dictionarydefinitionaugmented-dictionaryinformation) | [`DictionaryInformation`](#dictionaryinformation) | | +| [name](#dictionarydefinitionaugmented-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionaugmented-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitionaugmented-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | +| [repMap](#dictionarydefinitionaugmented-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionaugmented-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionaugmented-usecompounds) | `boolean` | Use Compounds. | + ### DictionaryDefinitionAugmented Fields + --- #### `description` {#dictionarydefinitionaugmented-description} +
Description
@@ -2354,10 +2728,14 @@ Optional description.
+ + + --- #### `dictionaryInformation` {#dictionarydefinitionaugmented-dictionaryinformation} +
Type
@@ -2368,10 +2746,14 @@ Optional description.
+ + + --- #### `name` {#dictionarydefinitionaugmented-name} +
Description
@@ -2396,10 +2778,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitionaugmented-nosuggest} +
Description
@@ -2423,10 +2809,14 @@ possible suggestions.
+ + + --- #### `path` {#dictionarydefinitionaugmented-path} +
Description
@@ -2444,10 +2834,14 @@ Path to the file.
+ + + --- #### `repMap` {#dictionarydefinitionaugmented-repmap} +
Description
@@ -2465,10 +2859,14 @@ Replacement pairs.
+ + + --- #### `type` {#dictionarydefinitionaugmented-type} +
Description
@@ -2493,10 +2891,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitionaugmented-usecompounds} +
Description
@@ -2514,26 +2916,31 @@ Use Compounds.
+ + ## DictionaryDefinitionCustom -| Field | Type | Description | -| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| [addWords](#dictionarydefinitioncustom-addwords) | `boolean` | When `true`, let's the spell checker know that words can be added to this dictionary. | -| [description](#dictionarydefinitioncustom-description) | `string` | Optional description. | -| [name](#dictionarydefinitioncustom-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioncustom-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitioncustom-path) | [`CustomDictionaryPath`](#customdictionarypath) | Path to custom dictionary text file. | -| [repMap](#dictionarydefinitioncustom-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [scope](#dictionarydefinitioncustom-scope) | [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` | Defines the scope for when words will be added to the dictionary. | -| [type](#dictionarydefinitioncustom-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioncustom-usecompounds) | `boolean` | Use Compounds. | +| Field | Type | Description | +| --- | --- | --- | +| [addWords](#dictionarydefinitioncustom-addwords) | `boolean` | When `true`, let's the spell checker know that words can be added to this dictionary. | +| [description](#dictionarydefinitioncustom-description) | `string` | Optional description. | +| [name](#dictionarydefinitioncustom-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioncustom-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitioncustom-path) | [`CustomDictionaryPath`](#customdictionarypath) | Path to custom dictionary text file. | +| [repMap](#dictionarydefinitioncustom-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [scope](#dictionarydefinitioncustom-scope) | [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)​`[]` | Defines the scope for when words will be added to the dictionary. | +| [type](#dictionarydefinitioncustom-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioncustom-usecompounds) | `boolean` | Use Compounds. | + ### DictionaryDefinitionCustom Fields + --- #### `addWords` {#dictionarydefinitioncustom-addwords} +
Description
@@ -2551,10 +2958,14 @@ When `true`, let's the spell checker know that words can be added to this dictio
+ + + --- #### `description` {#dictionarydefinitioncustom-description} +
Description
@@ -2572,10 +2983,14 @@ Optional description.
+ + + --- #### `name` {#dictionarydefinitioncustom-name} +
Description
@@ -2600,10 +3015,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitioncustom-nosuggest} +
Description
@@ -2627,10 +3046,14 @@ possible suggestions.
+ + + --- #### `path` {#dictionarydefinitioncustom-path} +
Description
@@ -2648,10 +3071,14 @@ Path to custom dictionary text file.
+ + + --- #### `repMap` {#dictionarydefinitioncustom-repmap} +
Description
@@ -2669,10 +3096,14 @@ Replacement pairs.
+ + + --- #### `scope` {#dictionarydefinitioncustom-scope} +
Description
@@ -2687,15 +3118,19 @@ Scope values: `user`, `workspace`, `folder`.
Type
-[`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]` +[`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)​`[]`
+ + + --- #### `type` {#dictionarydefinitioncustom-type} +
Description
@@ -2720,10 +3155,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitioncustom-usecompounds} +
Description
@@ -2741,10 +3180,15 @@ Use Compounds.
+ + + + --- ## DictionaryDefinitionInline {#dictionarydefinitioninline} +
Description
@@ -2762,27 +3206,32 @@ Inline Dictionary Definitions
+ + ## DictionaryDefinitionInlineFlagWords -| Field | Type | Description | -| ----------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlineflagwords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlineflagwords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlineflagwords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlineflagwords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineflagwords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineflagwords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineflagwords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineflagwords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlineflagwords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlineflagwords-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitioninlineflagwords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlineflagwords-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlineflagwords-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlineflagwords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlineflagwords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlineflagwords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlineflagwords-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlineflagwords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlineflagwords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlineflagwords-words) | `string`​`[]` | List of words to be considered correct. | + ### DictionaryDefinitionInlineFlagWords Fields + --- #### `description` {#dictionarydefinitioninlineflagwords-description} +
Description
@@ -2800,10 +3249,14 @@ Optional description.
+ + + --- #### `flagWords` {#dictionarydefinitioninlineflagwords-flagwords} +
Description
@@ -2830,15 +3283,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `ignoreWords` {#dictionarydefinitioninlineflagwords-ignorewords} +
Description
@@ -2852,15 +3309,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `name` {#dictionarydefinitioninlineflagwords-name} +
Description
@@ -2885,10 +3346,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitioninlineflagwords-nosuggest} +
Description
@@ -2912,10 +3377,14 @@ possible suggestions.
+ + + --- #### `repMap` {#dictionarydefinitioninlineflagwords-repmap} +
Description
@@ -2933,10 +3402,14 @@ Replacement pairs.
+ + + --- #### `suggestWords` {#dictionarydefinitioninlineflagwords-suggestwords} +
Description
@@ -2959,15 +3432,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `type` {#dictionarydefinitioninlineflagwords-type} +
Description
@@ -2992,10 +3469,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitioninlineflagwords-usecompounds} +
Description
@@ -3013,10 +3494,14 @@ Use Compounds.
+ + + --- #### `words` {#dictionarydefinitioninlineflagwords-words} +
Description
@@ -3029,32 +3514,37 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + ## DictionaryDefinitionInlineIgnoreWords -| Field | Type | Description | -| ------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlineignorewords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlineignorewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlineignorewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlineignorewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineignorewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineignorewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineignorewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineignorewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlineignorewords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlineignorewords-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitioninlineignorewords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlineignorewords-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlineignorewords-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlineignorewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlineignorewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlineignorewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlineignorewords-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlineignorewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlineignorewords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlineignorewords-words) | `string`​`[]` | List of words to be considered correct. | + ### DictionaryDefinitionInlineIgnoreWords Fields + --- #### `description` {#dictionarydefinitioninlineignorewords-description} +
Description
@@ -3072,10 +3562,14 @@ Optional description.
+ + + --- #### `flagWords` {#dictionarydefinitioninlineignorewords-flagwords} +
Description
@@ -3102,15 +3596,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `ignoreWords` {#dictionarydefinitioninlineignorewords-ignorewords} +
Description
@@ -3124,15 +3622,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `name` {#dictionarydefinitioninlineignorewords-name} +
Description
@@ -3157,10 +3659,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitioninlineignorewords-nosuggest} +
Description
@@ -3184,10 +3690,14 @@ possible suggestions.
+ + + --- #### `repMap` {#dictionarydefinitioninlineignorewords-repmap} +
Description
@@ -3205,10 +3715,14 @@ Replacement pairs.
+ + + --- #### `suggestWords` {#dictionarydefinitioninlineignorewords-suggestwords} +
Description
@@ -3231,15 +3745,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `type` {#dictionarydefinitioninlineignorewords-type} +
Description
@@ -3264,10 +3782,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitioninlineignorewords-usecompounds} +
Description
@@ -3285,10 +3807,14 @@ Use Compounds.
+ + + --- #### `words` {#dictionarydefinitioninlineignorewords-words} +
Description
@@ -3301,32 +3827,37 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + ## DictionaryDefinitionInlineWords -| Field | Type | Description | -| ------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [description](#dictionarydefinitioninlinewords-description) | `string` | Optional description. | -| [flagWords](#dictionarydefinitioninlinewords-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [ignoreWords](#dictionarydefinitioninlinewords-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [name](#dictionarydefinitioninlinewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlinewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlinewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlinewords-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlinewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitioninlinewords-usecompounds) | `boolean` | Use Compounds. | -| [words](#dictionarydefinitioninlinewords-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitioninlinewords-description) | `string` | Optional description. | +| [flagWords](#dictionarydefinitioninlinewords-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [ignoreWords](#dictionarydefinitioninlinewords-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [name](#dictionarydefinitioninlinewords-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitioninlinewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [repMap](#dictionarydefinitioninlinewords-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [suggestWords](#dictionarydefinitioninlinewords-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [type](#dictionarydefinitioninlinewords-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitioninlinewords-usecompounds) | `boolean` | Use Compounds. | +| [words](#dictionarydefinitioninlinewords-words) | `string`​`[]` | List of words to be considered correct. | + ### DictionaryDefinitionInlineWords Fields + --- #### `description` {#dictionarydefinitioninlinewords-description} +
Description
@@ -3344,10 +3875,14 @@ Optional description.
+ + + --- #### `flagWords` {#dictionarydefinitioninlinewords-flagwords} +
Description
@@ -3374,15 +3909,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `ignoreWords` {#dictionarydefinitioninlinewords-ignorewords} +
Description
@@ -3396,15 +3935,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `name` {#dictionarydefinitioninlinewords-name} +
Description
@@ -3429,10 +3972,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitioninlinewords-nosuggest} +
Description
@@ -3456,10 +4003,14 @@ possible suggestions.
+ + + --- #### `repMap` {#dictionarydefinitioninlinewords-repmap} +
Description
@@ -3477,10 +4028,14 @@ Replacement pairs.
+ + + --- #### `suggestWords` {#dictionarydefinitioninlinewords-suggestwords} +
Description
@@ -3503,15 +4058,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `type` {#dictionarydefinitioninlinewords-type} +
Description
@@ -3536,10 +4095,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitioninlinewords-usecompounds} +
Description
@@ -3557,10 +4120,14 @@ Use Compounds.
+ + + --- #### `words` {#dictionarydefinitioninlinewords-words} +
Description
@@ -3573,29 +4140,34 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + ## DictionaryDefinitionPreferred -| Field | Type | Description | -| ----------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionpreferred-description) | `string` | Optional description. | -| [name](#dictionarydefinitionpreferred-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitionpreferred-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitionpreferred-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | -| [repMap](#dictionarydefinitionpreferred-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | -| [type](#dictionarydefinitionpreferred-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | -| [useCompounds](#dictionarydefinitionpreferred-usecompounds) | `boolean` | Use Compounds. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#dictionarydefinitionpreferred-description) | `string` | Optional description. | +| [name](#dictionarydefinitionpreferred-name) | [`DictionaryId`](#dictionaryid) | This is the name of a dictionary. | +| [noSuggest](#dictionarydefinitionpreferred-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | +| [path](#dictionarydefinitionpreferred-path) | [`DictionaryPath`](#dictionarypath) | Path to the file. | +| [repMap](#dictionarydefinitionpreferred-repmap) | [`ReplaceMap`](#replacemap) | Replacement pairs. | +| [type](#dictionarydefinitionpreferred-type) | [`DictionaryFileTypes`](#dictionaryfiletypes) | Type of file: | +| [useCompounds](#dictionarydefinitionpreferred-usecompounds) | `boolean` | Use Compounds. | + ### DictionaryDefinitionPreferred Fields + --- #### `description` {#dictionarydefinitionpreferred-description} +
Description
@@ -3613,10 +4185,14 @@ Optional description.
+ + + --- #### `name` {#dictionarydefinitionpreferred-name} +
Description
@@ -3641,10 +4217,14 @@ Name Format:
+ + + --- #### `noSuggest` {#dictionarydefinitionpreferred-nosuggest} +
Description
@@ -3668,10 +4248,14 @@ possible suggestions.
+ + + --- #### `path` {#dictionarydefinitionpreferred-path} +
Description
@@ -3689,10 +4273,14 @@ Path to the file.
+ + + --- #### `repMap` {#dictionarydefinitionpreferred-repmap} +
Description
@@ -3710,10 +4298,14 @@ Replacement pairs.
+ + + --- #### `type` {#dictionarydefinitionpreferred-type} +
Description
@@ -3738,10 +4330,14 @@ C is the slowest to load due to the need to split each line based upon code spli
+ + + --- #### `useCompounds` {#dictionarydefinitionpreferred-usecompounds} +
Description
@@ -3759,10 +4355,15 @@ Use Compounds.
+ + + + --- ## DictionaryFileTypes {#dictionaryfiletypes} +
Type
@@ -3773,10 +4374,15 @@ Use Compounds.
+ + + + --- ## DictionaryId {#dictionaryid} +
Description
@@ -3801,25 +4407,30 @@ Name Format:
+ + ## DictionaryInformation -| Field | Type | Description | -| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| [accents](#dictionaryinformation-accents) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The accent characters. | -| [adjustments](#dictionaryinformation-adjustments) | [`PatternAdjustment`](#patternadjustment)`[]` | A collection of patterns to test against the suggested words. | -| [alphabet](#dictionaryinformation-alphabet) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` | The alphabet to use. | -| [costs](#dictionaryinformation-costs) | [`EditCosts`](#editcosts) | Define edit costs. | -| [hunspellInformation](#dictionaryinformation-hunspellinformation) | [`HunspellInformation`](#hunspellinformation) | Used by dictionary authors | -| [ignore](#dictionaryinformation-ignore) | [`CharacterSet`](#characterset) | An optional set of characters that can possibly be removed from a word before | -| [locale](#dictionaryinformation-locale) | `string` | The locale of the dictionary. | -| [suggestionEditCosts](#dictionaryinformation-suggestioneditcosts) | [`SuggestionCostsDefs`](#suggestioncostsdefs) | Used in making suggestions. The lower the value, the more likely the suggestion | +| Field | Type | Description | +| --- | --- | --- | +| [accents](#dictionaryinformation-accents) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)​`[]` | The accent characters. | +| [adjustments](#dictionaryinformation-adjustments) | [`PatternAdjustment`](#patternadjustment)​`[]` | A collection of patterns to test against the suggested words. | +| [alphabet](#dictionaryinformation-alphabet) | [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)​`[]` | The alphabet to use. | +| [costs](#dictionaryinformation-costs) | [`EditCosts`](#editcosts) | Define edit costs. | +| [hunspellInformation](#dictionaryinformation-hunspellinformation) | [`HunspellInformation`](#hunspellinformation) | Used by dictionary authors | +| [ignore](#dictionaryinformation-ignore) | [`CharacterSet`](#characterset) | An optional set of characters that can possibly be removed from a word before | +| [locale](#dictionaryinformation-locale) | `string` | The locale of the dictionary. | +| [suggestionEditCosts](#dictionaryinformation-suggestioneditcosts) | [`SuggestionCostsDefs`](#suggestioncostsdefs) | Used in making suggestions. The lower the value, the more likely the suggestion | + ### DictionaryInformation Fields + --- #### `accents` {#dictionaryinformation-accents} +
Description
@@ -3834,15 +4445,19 @@ Default: `"\u0300-\u0341"`
Type
-[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` +[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)​`[]`
+ + + --- #### `adjustments` {#dictionaryinformation-adjustments} +
Description
@@ -3856,15 +4471,19 @@ If the word matches the pattern, then the penalty is applied.
Type
-[`PatternAdjustment`](#patternadjustment)`[]` +[`PatternAdjustment`](#patternadjustment)​`[]`
+ + + --- #### `alphabet` {#dictionaryinformation-alphabet} +
Description
@@ -3877,15 +4496,19 @@ The alphabet to use.
Type
-[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]` +[`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)​`[]`
+ + + --- #### `costs` {#dictionaryinformation-costs} +
Description
@@ -3903,10 +4526,14 @@ Define edit costs.
+ + + --- #### `hunspellInformation` {#dictionaryinformation-hunspellinformation} +
Description
@@ -3924,10 +4551,14 @@ Used by dictionary authors
+ + + --- #### `ignore` {#dictionaryinformation-ignore} +
Description
@@ -3950,10 +4581,14 @@ Note: All matching characters are removed or none. Partial removal is not suppor
+ + + --- #### `locale` {#dictionaryinformation-locale} +
Description
@@ -3972,10 +4607,14 @@ Example: `nl,nl-be`
+ + + --- #### `suggestionEditCosts` {#dictionaryinformation-suggestioneditcosts} +
Description
@@ -3994,10 +4633,15 @@ will be near the top of the suggestion list.
+ + + + --- ## DictionaryNegRef {#dictionarynegref} +
Description
@@ -4024,10 +4668,15 @@ The reference starts with 1 or more `!`.
+ + + + --- ## DictionaryPath {#dictionarypath} +
Description
@@ -4046,10 +4695,15 @@ Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$`
+ + + + --- ## DictionaryRef {#dictionaryref} +
Description
@@ -4068,10 +4722,15 @@ It is expected to match the name of a dictionary.
+ + + + --- ## DictionaryReference {#dictionaryreference} +
Description
@@ -4092,22 +4751,27 @@ One of:
+ + ## EditCosts -| Field | Type | Description | -| --------------------------------------------------- | -------- | ---------------------------------------------------------------- | -| [accentCosts](#editcosts-accentcosts) | `number` | The cost to add / remove an accent | -| [baseCost](#editcosts-basecost) | `number` | This is the base cost for making an edit. | -| [capsCosts](#editcosts-capscosts) | `number` | The cost to change capitalization. | -| [firstLetterPenalty](#editcosts-firstletterpenalty) | `number` | The extra cost incurred for changing the first letter of a word. | -| [nonAlphabetCosts](#editcosts-nonalphabetcosts) | `number` | This is the cost for characters not in the alphabet. | +| Field | Type | Description | +| --- | --- | --- | +| [accentCosts](#editcosts-accentcosts) | `number` | The cost to add / remove an accent | +| [baseCost](#editcosts-basecost) | `number` | This is the base cost for making an edit. | +| [capsCosts](#editcosts-capscosts) | `number` | The cost to change capitalization. | +| [firstLetterPenalty](#editcosts-firstletterpenalty) | `number` | The extra cost incurred for changing the first letter of a word. | +| [nonAlphabetCosts](#editcosts-nonalphabetcosts) | `number` | This is the cost for characters not in the alphabet. | + ### EditCosts Fields + --- #### `accentCosts` {#editcosts-accentcosts} +
Description
@@ -4126,10 +4790,14 @@ This should be very cheap, it helps with fixing accent issues.
+ + + --- #### `baseCost` {#editcosts-basecost} +
Description
@@ -4147,10 +4815,14 @@ This is the base cost for making an edit.
+ + + --- #### `capsCosts` {#editcosts-capscosts} +
Description
@@ -4169,10 +4841,14 @@ This should be very cheap, it helps with fixing capitalization issues.
+ + + --- #### `firstLetterPenalty` {#editcosts-firstletterpenalty} +
Description
@@ -4191,10 +4867,14 @@ This value should be less than `100 - baseCost`.
+ + + --- #### `nonAlphabetCosts` {#editcosts-nonalphabetcosts} +
Description
@@ -4212,10 +4892,15 @@ This is the cost for characters not in the alphabet.
+ + + + --- ## FSPathResolvable {#fspathresolvable} +
Description
@@ -4237,10 +4922,15 @@ Special Properties:
+ + + + --- ## FeatureEnableOnly {#featureenableonly} +
Type
@@ -4251,18 +4941,23 @@ Special Properties:
+ + ## Features -| Field | Type | Description | -| ------------------------------------------------------ | ----------------------------------------- | ------------------------------------------ | -| [weighted-suggestions](#features-weighted-suggestions) | [`FeatureEnableOnly`](#featureenableonly) | Enable/disable using weighted suggestions. | +| Field | Type | Description | +| --- | --- | --- | +| [weighted-suggestions](#features-weighted-suggestions) | [`FeatureEnableOnly`](#featureenableonly) | Enable/disable using weighted suggestions. | + ### Features Fields + --- #### `weighted-suggestions` {#features-weighted-suggestions} +
Description
@@ -4280,10 +4975,15 @@ Enable/disable using weighted suggestions.
+ + + + --- ## FsDictionaryPath {#fsdictionarypath} +
Description
@@ -4301,10 +5001,15 @@ A File System Path. Relative paths are relative to the configuration file.
+ + + + --- ## FsPath {#fspath} +
Description
@@ -4322,10 +5027,15 @@ A File System Path. Relative paths are relative to the configuration file.
+ + + + --- ## Glob {#glob} +
Description
@@ -4343,19 +5053,24 @@ These are glob expressions.
+ + ## HunspellInformation -| Field | Type | Description | -| ----------------------------------- | -------- | --------------------------------------------------- | -| [aff](#hunspellinformation-aff) | `string` | Selected Hunspell AFF content. | -| [costs](#hunspellinformation-costs) | `object` | The costs to apply when using the hunspell settings | +| Field | Type | Description | +| --- | --- | --- | +| [aff](#hunspellinformation-aff) | `string` | Selected Hunspell AFF content. | +| [costs](#hunspellinformation-costs) | `object` | The costs to apply when using the hunspell settings | + ### HunspellInformation Fields + --- #### `aff` {#hunspellinformation-aff} +
Description
@@ -4393,10 +5108,14 @@ MAP (IJ)(IJ)
+ + + --- #### `costs` {#hunspellinformation-costs} +
Description
@@ -4414,10 +5133,15 @@ The costs to apply when using the hunspell settings
+ + + + --- ## LanguageId {#languageid} +
Type
@@ -4428,10 +5152,15 @@ The costs to apply when using the hunspell settings
+ + + + --- ## LanguageIdMultiple {#languageidmultiple} +
Description
@@ -4449,10 +5178,15 @@ This can be 'typescript,cpp,json,literal haskell', etc.
+ + + + --- ## LanguageIdMultipleNeg {#languageidmultipleneg} +
Description
@@ -4470,10 +5204,15 @@ This can be 'typescript,cpp,json,literal haskell', etc.
+ + + + --- ## LanguageIdSingle {#languageidsingle} +
Description
@@ -4491,36 +5230,41 @@ This can be '*', 'typescript', 'cpp', 'json', etc.
+ + ## LanguageSetting -| Field | Type | Description | -| --------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [allowCompoundWords](#languagesetting-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | -| [caseSensitive](#languagesetting-casesensitive) | `boolean` | Determines if words must match case and accent rules. | -| [description](#languagesetting-description) | `string` | Optional description of configuration. | -| [dictionaries](#languagesetting-dictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#languagesetting-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)`[]` | Define additional available dictionaries. | -| [enabled](#languagesetting-enabled) | `boolean` | Is the spell checker enabled. | -| [flagWords](#languagesetting-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [id](#languagesetting-id) | `string` | Optional identifier. | -| [ignoreRegExpList](#languagesetting-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | -| [ignoreWords](#languagesetting-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [includeRegExpList](#languagesetting-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | -| [languageId](#languagesetting-languageid) | [`MatchingFileType`](#matchingfiletype) | The language id. Ex: "typescript", "html", or "php". "\*" -- will match all languages. | -| [local](#languagesetting-local) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | Deprecated - The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | -| [locale](#languagesetting-locale) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` | The locale filter, matches against the language. This can be a comma separated list. "\*" will match all locales. | -| [name](#languagesetting-name) | `string` | Optional name of configuration. | -| [noSuggestDictionaries](#languagesetting-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries that will not be used for suggestions. | -| [patterns](#languagesetting-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | -| [suggestWords](#languagesetting-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [words](#languagesetting-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [allowCompoundWords](#languagesetting-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | +| [caseSensitive](#languagesetting-casesensitive) | `boolean` | Determines if words must match case and accent rules. | +| [description](#languagesetting-description) | `string` | Optional description of configuration. | +| [dictionaries](#languagesetting-dictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | +| [dictionaryDefinitions](#languagesetting-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)​`[]` | Define additional available dictionaries. | +| [enabled](#languagesetting-enabled) | `boolean` | Is the spell checker enabled. | +| [flagWords](#languagesetting-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [id](#languagesetting-id) | `string` | Optional identifier. | +| [ignoreRegExpList](#languagesetting-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | +| [ignoreWords](#languagesetting-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [includeRegExpList](#languagesetting-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | +| [languageId](#languagesetting-languageid) | [`MatchingFileType`](#matchingfiletype) | The language id. Ex: "typescript", "html", or "php". "*" -- will match all languages. | +| [local](#languagesetting-local) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)​`[]` | Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. | +| [locale](#languagesetting-locale) | [`LocaleId`](#localeid)
[`LocaleId`](#localeid)​`[]` | The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. | +| [name](#languagesetting-name) | `string` | Optional name of configuration. | +| [noSuggestDictionaries](#languagesetting-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries that will not be used for suggestions. | +| [patterns](#languagesetting-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)​`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | +| [suggestWords](#languagesetting-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [words](#languagesetting-words) | `string`​`[]` | List of words to be considered correct. | + ### LanguageSetting Fields + --- #### `allowCompoundWords` {#languagesetting-allowcompoundwords} +
Description
@@ -4538,10 +5282,14 @@ True to enable compound word checking. See [Case Sensitivity](https://cspell.org
+ + + --- #### `caseSensitive` {#languagesetting-casesensitive} +
Description
@@ -4563,10 +5311,14 @@ Determines if words must match case and accent rules.
+ + + --- #### `description` {#languagesetting-description} +
Description
@@ -4584,10 +5336,14 @@ Optional description of configuration.
+ + + --- #### `dictionaries` {#languagesetting-dictionaries} +
Description
@@ -4607,15 +5363,19 @@ and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `dictionaryDefinitions` {#languagesetting-dictionarydefinitions} +
Description
@@ -4637,15 +5397,19 @@ For example, you can use the following to add a custom dictionary:
Type
-[`DictionaryDefinition`](#dictionarydefinition)`[]` +[`DictionaryDefinition`](#dictionarydefinition)​`[]`
+ + + --- #### `enabled` {#languagesetting-enabled} +
Description
@@ -4663,9 +5427,13 @@ Is the spell checker enabled.
---- -#### `flagWords` {#languagesetting-flagwords} + + +--- + +#### `flagWords` {#languagesetting-flagwords} +
@@ -4693,15 +5461,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `id` {#languagesetting-id} +
Description
@@ -4719,10 +5491,14 @@ Optional identifier.
+ + + --- #### `ignoreRegExpList` {#languagesetting-ignoreregexplist} +
Description
@@ -4764,10 +5540,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `ignoreWords` {#languagesetting-ignorewords} +
Description
@@ -4781,15 +5561,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `includeRegExpList` {#languagesetting-includeregexplist} +
Description
@@ -4812,10 +5596,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `languageId` {#languagesetting-languageid} +
Description
@@ -4833,10 +5621,14 @@ The language id. Ex: "typescript", "html", or "php". "*" -- will match all lan
+ + + --- #### `local` {#languagesetting-local} +
Description
@@ -4849,15 +5641,19 @@ Deprecated - The locale filter, matches against the language. This can be a comm
Type
-[`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` +[`LocaleId`](#localeid)
[`LocaleId`](#localeid)​`[]`
+ + + --- #### `locale` {#languagesetting-locale} +
Description
@@ -4870,15 +5666,19 @@ The locale filter, matches against the language. This can be a comma separated l
Type
-[`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]` +[`LocaleId`](#localeid)
[`LocaleId`](#localeid)​`[]`
+ + + --- #### `name` {#languagesetting-name} +
Description
@@ -4896,10 +5696,14 @@ Optional name of configuration.
+ + + --- #### `noSuggestDictionaries` {#languagesetting-nosuggestdictionaries} +
Description
@@ -4918,15 +5722,19 @@ possible suggestions.
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `patterns` {#languagesetting-patterns} +
Description
@@ -4963,15 +5771,19 @@ Defines a list of patterns that can be used with the `ignoreRegExpList` and
Type
-[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` +[`RegExpPatternDefinition`](#regexppatterndefinition)​`[]`
+ + + --- #### `suggestWords` {#languagesetting-suggestwords} +
Description
@@ -4994,15 +5806,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `words` {#languagesetting-words} +
Description
@@ -5015,15 +5831,20 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + + + --- ## LocaleId {#localeid} +
Description
@@ -5041,63 +5862,73 @@ This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.
+ + + + --- ## MatchingFileType {#matchingfiletype} +
Type
-[`LanguageId`](#languageid)
[`LanguageId`](#languageid)`[]` +[`LanguageId`](#languageid)
[`LanguageId`](#languageid)​`[]`
+ + ## OverrideSettings -| Field | Type | Description | -| ---------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [allowCompoundWords](#overridesettings-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | -| [caseSensitive](#overridesettings-casesensitive) | `boolean` | Determines if words must match case and accent rules. | -| [description](#overridesettings-description) | `string` | Optional description of configuration. | -| [dictionaries](#overridesettings-dictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#overridesettings-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)`[]` | Define additional available dictionaries. | -| [enableFiletypes](#overridesettings-enablefiletypes) | [`LanguageIdSingle`](#languageidsingle)`[]` | Enable / Disable checking file types (languageIds). | -| [enabled](#overridesettings-enabled) | `boolean` | Is the spell checker enabled. | -| [enabledFileTypes](#overridesettings-enabledfiletypes) | `object` | Enable / Disable checking file types (languageIds). | -| [enabledLanguageIds](#overridesettings-enabledlanguageids) | [`LanguageIdSingle`](#languageidsingle)`[]` | Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. | -| [filename](#overridesettings-filename) | [`Glob`](#glob)
[`Glob`](#glob)`[]` | Glob pattern or patterns to match against. | -| [flagWords](#overridesettings-flagwords) | `string``[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | -| [id](#overridesettings-id) | `string` | Optional identifier. | -| [ignoreRegExpList](#overridesettings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | -| [ignoreWords](#overridesettings-ignorewords) | `string``[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | -| [includeRegExpList](#overridesettings-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | -| [language](#overridesettings-language) | [`LocaleId`](#localeid) | Sets the locale. | -| [languageId](#overridesettings-languageid) | [`MatchingFileType`](#matchingfiletype) | Sets the programming language id to match file type. | -| [languageSettings](#overridesettings-languagesettings) | [`LanguageSetting`](#languagesetting)`[]` | Additional settings for individual languages. | -| [loadDefaultConfiguration](#overridesettings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` | -| [maxDuplicateProblems](#overridesettings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. | -| [maxNumberOfProblems](#overridesettings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. | -| [minWordLength](#overridesettings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. | -| [name](#overridesettings-name) | `string` | Optional name of configuration. | -| [noSuggestDictionaries](#overridesettings-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)`[]` | Optional list of dictionaries that will not be used for suggestions. | -| [numSuggestions](#overridesettings-numsuggestions) | `number` | Number of suggestions to make. | -| [patterns](#overridesettings-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | -| [pnpFiles](#overridesettings-pnpfiles) | `string``[]` | The PnP files to search for. Note: `.mjs` files are not currently supported. | -| [suggestWords](#overridesettings-suggestwords) | `string``[]` | A list of suggested replacements for words. | -| [suggestionNumChanges](#overridesettings-suggestionnumchanges) | `number` | The maximum number of changes allowed on a word to be considered a suggestions. | -| [suggestionsTimeout](#overridesettings-suggestionstimeout) | `number` | The maximum amount of time in milliseconds to generate suggestions for a word. | -| [usePnP](#overridesettings-usepnp) | `boolean` | Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading | -| [words](#overridesettings-words) | `string``[]` | List of words to be considered correct. | +| Field | Type | Description | +| --- | --- | --- | +| [allowCompoundWords](#overridesettings-allowcompoundwords) | `boolean` | True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details. | +| [caseSensitive](#overridesettings-casesensitive) | `boolean` | Determines if words must match case and accent rules. | +| [description](#overridesettings-description) | `string` | Optional description of configuration. | +| [dictionaries](#overridesettings-dictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | +| [dictionaryDefinitions](#overridesettings-dictionarydefinitions) | [`DictionaryDefinition`](#dictionarydefinition)​`[]` | Define additional available dictionaries. | +| [enableFiletypes](#overridesettings-enablefiletypes) | [`LanguageIdSingle`](#languageidsingle)​`[]` | Enable / Disable checking file types (languageIds). | +| [enabled](#overridesettings-enabled) | `boolean` | Is the spell checker enabled. | +| [enabledFileTypes](#overridesettings-enabledfiletypes) | `object` | Enable / Disable checking file types (languageIds). | +| [enabledLanguageIds](#overridesettings-enabledlanguageids) | [`LanguageIdSingle`](#languageidsingle)​`[]` | Specify a list of file types to spell check. It is better to use [Settings.enabledFileTypes](#settings-enabledfiletypes) to Enable / Disable checking files types. | +| [filename](#overridesettings-filename) | [`Glob`](#glob)
[`Glob`](#glob)​`[]` | Glob pattern or patterns to match against. | +| [flagWords](#overridesettings-flagwords) | `string`​`[]` | List of words to always be considered incorrect. Words found in `flagWords` override `words`. | +| [id](#overridesettings-id) | `string` | Optional identifier. | +| [ignoreRegExpList](#overridesettings-ignoreregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or pattern names to exclude from spell checking. | +| [ignoreWords](#overridesettings-ignorewords) | `string`​`[]` | List of words to be ignored. An ignored word will not show up as an error, even if it is | +| [includeRegExpList](#overridesettings-includeregexplist) | [`RegExpPatternList`](#regexppatternlist) | List of regular expression patterns or defined pattern names to match for spell checking. | +| [language](#overridesettings-language) | [`LocaleId`](#localeid) | Sets the locale. | +| [languageId](#overridesettings-languageid) | [`MatchingFileType`](#matchingfiletype) | Sets the programming language id to match file type. | +| [languageSettings](#overridesettings-languagesettings) | [`LanguageSetting`](#languagesetting)​`[]` | Additional settings for individual languages. | +| [loadDefaultConfiguration](#overridesettings-loaddefaultconfiguration) | `boolean` | By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` | +| [maxDuplicateProblems](#overridesettings-maxduplicateproblems) | `number` | The maximum number of times the same word can be flagged as an error in a file. | +| [maxNumberOfProblems](#overridesettings-maxnumberofproblems) | `number` | The maximum number of problems to report in a file. | +| [minWordLength](#overridesettings-minwordlength) | `number` | The minimum length of a word before checking it against a dictionary. | +| [name](#overridesettings-name) | `string` | Optional name of configuration. | +| [noSuggestDictionaries](#overridesettings-nosuggestdictionaries) | [`DictionaryReference`](#dictionaryreference)​`[]` | Optional list of dictionaries that will not be used for suggestions. | +| [numSuggestions](#overridesettings-numsuggestions) | `number` | Number of suggestions to make. | +| [patterns](#overridesettings-patterns) | [`RegExpPatternDefinition`](#regexppatterndefinition)​`[]` | Defines a list of patterns that can be used with the `ignoreRegExpList` and | +| [pnpFiles](#overridesettings-pnpfiles) | `string`​`[]` | The PnP files to search for. Note: `.mjs` files are not currently supported. | +| [suggestWords](#overridesettings-suggestwords) | `string`​`[]` | A list of suggested replacements for words. | +| [suggestionNumChanges](#overridesettings-suggestionnumchanges) | `number` | The maximum number of changes allowed on a word to be considered a suggestions. | +| [suggestionsTimeout](#overridesettings-suggestionstimeout) | `number` | The maximum amount of time in milliseconds to generate suggestions for a word. | +| [usePnP](#overridesettings-usepnp) | `boolean` | Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading | +| [words](#overridesettings-words) | `string`​`[]` | List of words to be considered correct. | + ### OverrideSettings Fields + --- #### `allowCompoundWords` {#overridesettings-allowcompoundwords} +
Description
@@ -5115,10 +5946,14 @@ True to enable compound word checking. See [Case Sensitivity](https://cspell.org
+ + + --- #### `caseSensitive` {#overridesettings-casesensitive} +
Description
@@ -5140,10 +5975,14 @@ Determines if words must match case and accent rules.
+ + + --- #### `description` {#overridesettings-description} +
Description
@@ -5161,10 +6000,14 @@ Optional description of configuration.
+ + + --- #### `dictionaries` {#overridesettings-dictionaries} +
Description
@@ -5184,15 +6027,19 @@ and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `dictionaryDefinitions` {#overridesettings-dictionarydefinitions} +
Description
@@ -5214,15 +6061,19 @@ For example, you can use the following to add a custom dictionary:
Type
-[`DictionaryDefinition`](#dictionarydefinition)`[]` +[`DictionaryDefinition`](#dictionarydefinition)​`[]`
+ + + --- #### `enableFiletypes` {#overridesettings-enablefiletypes} +
Description
@@ -5254,15 +6105,19 @@ kotlin // enable checking for kotlin
Type
-[`LanguageIdSingle`](#languageidsingle)`[]` +[`LanguageIdSingle`](#languageidsingle)​`[]`
+ + + --- #### `enabled` {#overridesettings-enabled} +
Description
@@ -5280,10 +6135,14 @@ Is the spell checker enabled.
+ + + --- #### `enabledFileTypes` {#overridesettings-enabledfiletypes} +
Description
@@ -5316,10 +6175,14 @@ A file type of `*` is a wildcard that enables all file types.
+ + + --- #### `enabledLanguageIds` {#overridesettings-enabledlanguageids} +
Description
@@ -5332,15 +6195,19 @@ Specify a list of file types to spell check. It is better to use [Settings.enab
Type
-[`LanguageIdSingle`](#languageidsingle)`[]` +[`LanguageIdSingle`](#languageidsingle)​`[]`
+ + + --- #### `filename` {#overridesettings-filename} +
Description
@@ -5353,15 +6220,19 @@ Glob pattern or patterns to match against.
Type
-[`Glob`](#glob)
[`Glob`](#glob)`[]` +[`Glob`](#glob)
[`Glob`](#glob)​`[]`
+ + + --- #### `flagWords` {#overridesettings-flagwords} +
Description
@@ -5388,15 +6259,19 @@ Example:
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `id` {#overridesettings-id} +
Description
@@ -5414,10 +6289,14 @@ Optional identifier.
+ + + --- #### `ignoreRegExpList` {#overridesettings-ignoreregexplist} +
Description
@@ -5459,10 +6338,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `ignoreWords` {#overridesettings-ignorewords} +
Description
@@ -5476,15 +6359,19 @@ also in the `flagWords`.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `includeRegExpList` {#overridesettings-includeregexplist} +
Description
@@ -5507,10 +6394,14 @@ While you can create your own patterns, you can also leverage several patterns t
+ + + --- #### `language` {#overridesettings-language} +
Description
@@ -5528,10 +6419,14 @@ Sets the locale.
+ + + --- #### `languageId` {#overridesettings-languageid} +
Description
@@ -5549,10 +6444,14 @@ Sets the programming language id to match file type.
+ + + --- #### `languageSettings` {#overridesettings-languagesettings} +
Description
@@ -5567,15 +6466,19 @@ See [Language Settings](https://cspell.org/configuration/language-settings/) for
Type
-[`LanguageSetting`](#languagesetting)`[]` +[`LanguageSetting`](#languagesetting)​`[]`
+ + + --- #### `loadDefaultConfiguration` {#overridesettings-loaddefaultconfiguration} +
Description
@@ -5594,10 +6497,14 @@ will prevent ALL default configuration from being loaded.
+ + + --- #### `maxDuplicateProblems` {#overridesettings-maxduplicateproblems} +
Description
@@ -5615,10 +6522,14 @@ The maximum number of times the same word can be flagged as an error in a file.
+ + + --- #### `maxNumberOfProblems` {#overridesettings-maxnumberofproblems} +
Description
@@ -5636,10 +6547,14 @@ The maximum number of problems to report in a file.
+ + + --- #### `minWordLength` {#overridesettings-minwordlength} +
Description
@@ -5657,10 +6572,14 @@ The minimum length of a word before checking it against a dictionary.
+ + + --- #### `name` {#overridesettings-name} +
Description
@@ -5678,10 +6597,14 @@ Optional name of configuration.
+ + + --- #### `noSuggestDictionaries` {#overridesettings-nosuggestdictionaries} +
Description
@@ -5700,15 +6623,19 @@ possible suggestions.
Type
-[`DictionaryReference`](#dictionaryreference)`[]` +[`DictionaryReference`](#dictionaryreference)​`[]`
+ + + --- #### `numSuggestions` {#overridesettings-numsuggestions} +
Description
@@ -5726,10 +6653,14 @@ Number of suggestions to make.
+ + + --- #### `patterns` {#overridesettings-patterns} +
Description
@@ -5766,15 +6697,19 @@ Defines a list of patterns that can be used with the `ignoreRegExpList` and
Type
-[`RegExpPatternDefinition`](#regexppatterndefinition)`[]` +[`RegExpPatternDefinition`](#regexppatterndefinition)​`[]`
+ + + --- #### `pnpFiles` {#overridesettings-pnpfiles} +
Description
@@ -5787,15 +6722,19 @@ The PnP files to search for. Note: `.mjs` files are not currently supported.
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `suggestWords` {#overridesettings-suggestwords} +
Description
@@ -5818,15 +6757,19 @@ Format of `suggestWords`
Type
-`string``[]` +`string`​`[]`
+ + + --- #### `suggestionNumChanges` {#overridesettings-suggestionnumchanges} +
Description
@@ -5848,10 +6791,14 @@ Range: between 1 and 5.
+ + + --- #### `suggestionsTimeout` {#overridesettings-suggestionstimeout} +
Description
@@ -5869,10 +6816,14 @@ The maximum amount of time in milliseconds to generate suggestions for a word.
+ + + --- #### `usePnP` {#overridesettings-usepnp} +
Description
@@ -5894,10 +6845,14 @@ of a PnP file and load it.
+ + + --- #### `words` {#overridesettings-words} +
Description
@@ -5910,15 +6865,20 @@ List of words to be considered correct.
Type
-`string``[]` +`string`​`[]`
+ + + + --- ## Pattern {#pattern} +
Type
@@ -5929,20 +6889,25 @@ List of words to be considered correct.
+ + ## PatternAdjustment -| Field | Type | Description | -| ------------------------------------- | -------- | ------------------------------------------- | -| [id](#patternadjustment-id) | `string` | Id of the Adjustment, i.e. `short-compound` | -| [penalty](#patternadjustment-penalty) | `number` | The amount of penalty to apply. | -| [regexp](#patternadjustment-regexp) | `string` | RegExp pattern to match | +| Field | Type | Description | +| --- | --- | --- | +| [id](#patternadjustment-id) | `string` | Id of the Adjustment, i.e. `short-compound` | +| [penalty](#patternadjustment-penalty) | `number` | The amount of penalty to apply. | +| [regexp](#patternadjustment-regexp) | `string` | RegExp pattern to match | + ### PatternAdjustment Fields + --- #### `id` {#patternadjustment-id} +
Description
@@ -5960,10 +6925,14 @@ Id of the Adjustment, i.e. `short-compound`
+ + + --- #### `penalty` {#patternadjustment-penalty} +
Description
@@ -5981,10 +6950,14 @@ The amount of penalty to apply.
+ + + --- #### `regexp` {#patternadjustment-regexp} +
Description
@@ -6002,10 +6975,15 @@ RegExp pattern to match
+ + + + --- ## PatternId {#patternid} +
Description
@@ -6023,10 +7001,15 @@ This matches the name in a pattern definition.
+ + + + --- ## PatternRef {#patternref} +
Description
@@ -6044,10 +7027,15 @@ A PatternRef is a Pattern or PatternId.
+ + + + --- ## PredefinedPatterns {#predefinedpatterns} +
Type
@@ -6058,20 +7046,25 @@ A PatternRef is a Pattern or PatternId.
+ + ## RegExpPatternDefinition -| Field | Type | Description | -| --------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------ | -| [description](#regexppatterndefinition-description) | `string` | Description of the pattern. | -| [name](#regexppatterndefinition-name) | [`PatternId`](#patternid) | Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. | -| [pattern](#regexppatterndefinition-pattern) | [`Pattern`](#pattern)
[`Pattern`](#pattern)`[]` | RegExp pattern or array of RegExp patterns. | +| Field | Type | Description | +| --- | --- | --- | +| [description](#regexppatterndefinition-description) | `string` | Description of the pattern. | +| [name](#regexppatterndefinition-name) | [`PatternId`](#patternid) | Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. | +| [pattern](#regexppatterndefinition-pattern) | [`Pattern`](#pattern)
[`Pattern`](#pattern)​`[]` | RegExp pattern or array of RegExp patterns. | + ### RegExpPatternDefinition Fields + --- #### `description` {#regexppatterndefinition-description} +
Description
@@ -6089,10 +7082,14 @@ Description of the pattern.
+ + + --- #### `name` {#regexppatterndefinition-name} +
Description
@@ -6111,10 +7108,14 @@ It is possible to redefine one of the predefined patterns to override its value.
+ + + --- #### `pattern` {#regexppatterndefinition-pattern} +
Description
@@ -6127,15 +7128,20 @@ RegExp pattern or array of RegExp patterns.
Type
-[`Pattern`](#pattern)
[`Pattern`](#pattern)`[]` +[`Pattern`](#pattern)
[`Pattern`](#pattern)​`[]`
+ + + + --- ## RegExpPatternList {#regexppatternlist} +
Description
@@ -6148,43 +7154,58 @@ A list of pattern names or regular expressions.
Type
-[`PatternRef`](#patternref)`[]` +[`PatternRef`](#patternref)​`[]`
+ + + + --- ## ReplaceEntry {#replaceentry} +
Type
-`string``[]` +`string`​`[]`
+ + + + --- ## ReplaceMap {#replacemap} +
Type
-[`ReplaceEntry`](#replaceentry)`[]` +[`ReplaceEntry`](#replaceentry)​`[]`
+ + + + --- ## ReporterModuleName {#reportermodulename} +
Description
@@ -6202,10 +7223,15 @@ The module or path to the the reporter to load.
+ + + + --- ## ReporterOptions {#reporteroptions} +
Description
@@ -6223,10 +7249,15 @@ Options to send to the reporter. These are defined by the reporter.
+ + + + --- ## ReporterSettings {#reportersettings} +
Description
@@ -6246,15 +7277,20 @@ Examples:
Type
-[`ReporterModuleName`](#reportermodulename)
[`ReporterModuleName`](#reportermodulename)`[]`
`Unknown``[]` +[`ReporterModuleName`](#reportermodulename)
[`ReporterModuleName`](#reportermodulename)​`[]`
`Unknown`​`[]`
+ + + + --- ## Serializable {#serializable} +
Type
@@ -6265,10 +7301,15 @@ Examples:
+ + + + --- ## SimpleGlob {#simpleglob} +
Description
@@ -6286,10 +7327,15 @@ Simple Glob string, the root will be globRoot.
+ + + + --- ## SuggestionCostMapDef {#suggestioncostmapdef} +
Description
@@ -6326,24 +7372,34 @@ Note: the default edit distance is 100.
+ + + + --- ## SuggestionCostsDefs {#suggestioncostsdefs} +
Type
-[`SuggestionCostMapDef`](#suggestioncostmapdef)`[]` +[`SuggestionCostMapDef`](#suggestioncostmapdef)​`[]`
+ + + + --- ## Version {#version} +
Type
@@ -6354,10 +7410,15 @@ Note: the default edit distance is 100.
+ + + + --- ## VersionLatest {#versionlatest} +
Description
@@ -6375,10 +7436,15 @@ Configuration File Version.
+ + + + --- ## VersionLegacy {#versionlegacy} +
Description
@@ -6395,3 +7461,4 @@ Legacy Configuration File Versions.
+