From acf59a4f92a3971021762f4fd006a4d3ff06f559 Mon Sep 17 00:00:00 2001 From: Felix Moeser Date: Wed, 12 Jun 2024 13:40:53 +0200 Subject: [PATCH] docs: work on configuration page (#5739) --- website/_scripts/extract-properties.mjs | 67 +- website/docs/Configuration/auto_properties.md | 6878 ++++++++--------- 2 files changed, 3438 insertions(+), 3507 deletions(-) diff --git a/website/_scripts/extract-properties.mjs b/website/_scripts/extract-properties.mjs index 290d9fa06b1..8da8a68b0ce 100644 --- a/website/_scripts/extract-properties.mjs +++ b/website/_scripts/extract-properties.mjs @@ -32,7 +32,7 @@ function schemaEntry(entry, name) { if (entry.type === 'object') { return schemaObjectEntry(entry, name); } - return `## ${name}\n**Not Handled:** ${entry.type}\n`; + return formatTopLevelType(name, entry); } function schemaObjectEntry(schemaTypeObject, nameOfType) { @@ -64,15 +64,21 @@ function schemaObjectEntry(schemaTypeObject, nameOfType) { /** * @param {string} name - name of heading - * @param {string} section - the containing entry name + * @param {string} [section] - the containing entry name + * @param {string} [text] - optional text to show in the link */ -function linkToHeader(name, section) { +function linkToHeader(name, section, text) { + text = text || name; const id = toId(section, name); - return `[${name}](#${id})`; + return `[${text}](#${id})`; } +/** + * @param {string | undefined} nameOfParentType + * @param {string} header + */ function toId(nameOfParentType, header) { - return `${nameOfParentType}-${header}`.toLowerCase().replaceAll(/\W/g, '-'); + return (nameOfParentType ? `${nameOfParentType}-${header}` : header).toLowerCase().replaceAll(/\W/g, '-'); } function formatPropertyForOverview(key, entry, section) { @@ -86,26 +92,40 @@ function formatPropertyToDisplay(key, entry, nameOfParentType) { #### \`${key}\` {#${toId(nameOfParentType, key)}} -
-
Name
+ ${padLines(formatTypeEntryBody(entry), ' ')} + `); +} + +function formatTopLevelType(key, entry) { + return removeLeftPad(` + + --- + + ## ${key} {#${toId('', key)}} + + ${padLines(formatTypeEntryBody(entry), ' ')} + `); +} + +function formatTypeEntryBody(entry) { + let dlDescription = formatEntryDescription(entry, ''); + if (dlDescription) { + dlDescription = removeLeftPad(` +
Description
- \`${key}\` + ${padLines(dlDescription, ' ')}
-
+ `); + } + return removeLeftPad(`
+ ${padLines(dlDescription, ' ')}
Type
${formatEntryType(entry)}
- -
-
Description
-
- ${formatEntryDescription(entry, ' ')} -
-
`); } @@ -118,13 +138,13 @@ function formatEntryType(entry, addFix = '`') { } if (entry.type === 'array' && entry.items) { - return fix(`${formatEntryType(entry.items, '')}[]`); + return formatEntryType(entry.items, '`') + fix(`[]`); } if (entry.type) { return fix(entry.type); } if (entry.$ref) { - return fix(entry.$ref.split('/').slice(-1).join('')); + return formatReferenceType(entry.$ref, fix); } if (entry.anyOf) { return entry.anyOf.map((entry) => formatEntryType(entry)).join('
'); @@ -132,6 +152,11 @@ function formatEntryType(entry, addFix = '`') { return fix('Unknown'); } +function formatReferenceType(ref, fnFix) { + const refType = ref.split('/').slice(-1).join(''); + return linkToHeader(refType, '', fnFix(refType)); +} + function formatDefinitions(schema) { return Object.entries(schema.definitions || {}) .map(([key, entry]) => schemaEntry(entry, key)) @@ -177,7 +202,7 @@ const regExpMatchLink = /\{@link (.*?)\}/g; function replaceLinks(markdown) { markdown = markdown.replaceAll(regExpMatchLink, (_match, p1) => { p1 = p1.trim(); - const link = (p1 && `[${p1}](#${p1.toLowerCase().replaceAll(/\W/g, '-')})`) || ''; + const link = (p1 && linkToHeader(p1, '')) || ''; return link; }); return markdown; @@ -185,10 +210,10 @@ function replaceLinks(markdown) { /** * @param {string} str - multi-line string to left pad - * @param {string} padding - the padding to use + * @param {string} [padding] - the padding to use * @param {string} [firstLinePadding] - optional padding of first line. */ -function padLines(str, padding, firstLinePadding = '') { +function padLines(str, padding = '', firstLinePadding = '') { let pad = firstLinePadding; const lines = []; for (const line of str.split('\n')) { diff --git a/website/docs/Configuration/auto_properties.md b/website/docs/Configuration/auto_properties.md index 959a5c6c3fe..563e89460ea 100644 --- a/website/docs/Configuration/auto_properties.md +++ b/website/docs/Configuration/auto_properties.md @@ -9,6574 +9,6480 @@ 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` | 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[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#settings-dictionarydefinitions) | `DictionaryDefinition[]` | Define additional available dictionaries. | -| [enableFiletypes](#settings-enablefiletypes) | `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[]` | 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` | Configure CSpell features. | -| [files](#settings-files) | `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[]` | Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. | -| [globRoot](#settings-globroot) | `FSPathResolvable` | The root to use for glob patterns found in this configuration. | -| [id](#settings-id) | `string` | Optional identifier. | -| [ignorePaths](#settings-ignorepaths) | `Glob[]` | Glob patterns of files to be ignored. | -| [ignoreRegExpList](#settings-ignoreregexplist) | `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[]` | Allows this configuration to inherit configuration for one or more other files. | -| [includeRegExpList](#settings-includeregexplist) | `RegExpPatternList` | List of regular expression patterns or defined pattern names to match for spell checking. | -| [language](#settings-language) | `LocaleId` | Current active spelling language. This specifies the language locale to use in choosing the | -| [languageId](#settings-languageid) | `MatchingFileType` | Forces the spell checker to assume a give language id. Used mainly as an Override. | -| [languageSettings](#settings-languagesettings) | `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[]` | Optional list of dictionaries that will not be used for suggestions. | -| [numSuggestions](#settings-numsuggestions) | `number` | Number of suggestions to make. | -| [overrides](#settings-overrides) | `OverrideSettings[]` | Overrides are used to apply settings for specific files in your project. | -| [patterns](#settings-patterns) | `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[]` | 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` | 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} +
-
Name
+ +
Description
- `$schema` + Url to JSON Schema
-
- -
+
Type
`string`
-
-
Description
-
- Url to JSON Schema -
-
+ + --- #### `allowCompoundWords` {#settings-allowcompoundwords} +
-
Name
+ +
Description
- `allowCompoundWords` + 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. -
-
+ + --- #### `cache` {#settings-cache} +
-
Name
+ +
Description
- `cache` + Define cache settings.
-
- -
+
Type
- `CacheSettings` + [`CacheSettings`](#cachesettings)
-
-
Description
-
- Define cache settings. -
-
+ + --- #### `caseSensitive` {#settings-casesensitive} +
-
Name
+ +
Description
- `caseSensitive` + 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. -
-
+ + --- #### `description` {#settings-description} +
-
Name
+ +
Description
- `description` + Optional description of configuration.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description of configuration. -
-
+ + --- #### `dictionaries` {#settings-dictionaries} +
-
Name
+ +
Description
- `dictionaries` + 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`](#dictionaryreference)`[]`
-
-
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. -
-
+ + --- #### `dictionaryDefinitions` {#settings-dictionarydefinitions} +
-
Name
+ +
Description
- `dictionaryDefinitions` + 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`](#dictionarydefinition)`[]`
-
-
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"] - ``` -
-
+ + --- #### `enableFiletypes` {#settings-enablefiletypes} +
-
Name
+ +
Description
- `enableFiletypes` + 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`](#languageidsingle)`[]`
-
-
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 - ``` -
-
+ + --- #### `enableGlobDot` {#settings-enableglobdot} +
-
Name
+ +
Description
- `enableGlobDot` + Enable scanning files and directories beginning with `.` (period). + + By default, CSpell does not scan `hidden` files.
-
- -
+
Type
`boolean`
-
-
Description
-
- Enable scanning files and directories beginning with `.` (period). - - By default, CSpell does not scan `hidden` files. -
-
+ + --- #### `enabled` {#settings-enabled} +
-
Name
+ +
Description
- `enabled` + Is the spell checker enabled.
-
- -
+
Type
`boolean`
-
-
Description
-
- Is the spell checker enabled. -
-
+ + --- #### `enabledFileTypes` {#settings-enabledfiletypes} +
-
Name
+ +
Description
- `enabledFileTypes` + 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`
-
-
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. | -
-
+ + --- #### `enabledLanguageIds` {#settings-enabledlanguageids} +
-
Name
+ +
Description
- `enabledLanguageIds` + 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`](#languageidsingle)`[]`
-
-
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. -
-
+ + --- #### `failFast` {#settings-failfast} +
-
Name
+ +
Description
- `failFast` + Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)
-
- -
+
Type
`boolean`
-
-
Description
-
- Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks) -
-
+ + --- #### `features` {#settings-features} +
-
Name
+ +
Description
- `features` + Configure CSpell features.
-
- -
+
Type
- `Features` + [`Features`](#features)
-
-
Description
-
- Configure CSpell features. -
-
+ + --- #### `files` {#settings-files} +
-
Name
+ +
Description
- `files` + Glob patterns of files to be checked. + + Glob patterns are relative to the `globRoot` of the configuration file that defines them.
-
- -
+
Type
- `Glob[]` + [`Glob`](#glob)`[]`
-
-
Description
-
- Glob patterns of files to be checked. - - Glob patterns are relative to the `globRoot` of the configuration file that defines them. -
-
+ + --- #### `flagWords` {#settings-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `gitignoreRoot` {#settings-gitignoreroot} +
-
Name
+ +
Description
- `gitignoreRoot` + Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root.
-
- -
+
Type
- `FsPath`
`FsPath[]` + [`FsPath`](#fspath)
[`FsPath`](#fspath)`[]`
-
-
Description
-
- Tells the spell checker to stop searching for `.gitignore` files when it reaches a matching root. -
-
+ + --- #### `globRoot` {#settings-globroot} +
-
Name
+ +
Description
- `globRoot` + 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`](#fspathresolvable)
-
-
Description
-
- The root to use for glob patterns found in this configuration. - Default: location of the configuration file. - For compatibility reasons, config files with version 0.1, the glob root will - default to be `${cwd}`. - - 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. -
-
+ + --- #### `id` {#settings-id} +
-
Name
+ +
Description
- `id` + Optional identifier.
-
- -
+
Type
`string`
-
-
Description
-
- Optional identifier. -
-
+ + --- #### `ignorePaths` {#settings-ignorepaths} +
-
Name
+ +
Description
- `ignorePaths` + Glob patterns of files to be ignored. + + Glob patterns are relative to the `globRoot` of the configuration file that defines them.
-
- -
+
Type
- `Glob[]` + [`Glob`](#glob)`[]`
-
-
Description
-
- Glob patterns of files to be ignored. - - Glob patterns are relative to the `globRoot` of the configuration file that defines them. -
-
+ + --- #### `ignoreRegExpList` {#settings-ignoreregexplist} +
-
Name
+ +
Description
- `ignoreRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `ignoreWords` {#settings-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `import` {#settings-import} +
-
Name
+ +
Description
- `import` + 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)
[`FsPath`](#fspath)`[]`
-
-
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. -
-
+ + --- #### `includeRegExpList` {#settings-includeregexplist} +
-
Name
+ +
Description
- `includeRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `language` {#settings-language} +
-
Name
+ +
Description
- `language` + 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`](#localeid)
-
-
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. -
-
+ + --- #### `languageId` {#settings-languageid} +
-
Name
+ +
Description
- `languageId` + Forces the spell checker to assume a give language id. Used mainly as an Override.
-
- -
+
Type
- `MatchingFileType` + [`MatchingFileType`](#matchingfiletype)
-
-
Description
-
- Forces the spell checker to assume a give language id. Used mainly as an Override. -
-
+ + --- #### `languageSettings` {#settings-languagesettings} +
-
Name
+ +
Description
- `languageSettings` + Additional settings for individual languages. + + See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
-
- -
+
Type
- `LanguageSetting[]` + [`LanguageSetting`](#languagesetting)`[]`
-
-
Description
-
- Additional settings for individual languages. - - See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. -
-
+ + --- #### `loadDefaultConfiguration` {#settings-loaddefaultconfiguration} +
-
Name
+ +
Description
- `loadDefaultConfiguration` + By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` + will prevent ALL default configuration from being loaded.
-
- -
+
Type
`boolean`
-
-
Description
-
- By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` - will prevent ALL default configuration from being loaded. -
-
+ + --- #### `maxDuplicateProblems` {#settings-maxduplicateproblems} +
-
Name
+ +
Description
- `maxDuplicateProblems` + The maximum number of times the same word can be flagged as an error in a file.
-
- -
+
Type
`number`
-
-
Description
-
- The maximum number of times the same word can be flagged as an error in a file. -
-
+ + --- #### `maxNumberOfProblems` {#settings-maxnumberofproblems} +
-
Name
+ +
Description
- `maxNumberOfProblems` + The maximum number of problems to report in a file.
-
- -
+
Type
`number`
-
-
Description
-
- The maximum number of problems to report in a file. -
-
+ + --- #### `minWordLength` {#settings-minwordlength} +
-
Name
+ +
Description
- `minWordLength` + The minimum length of a word before checking it against a dictionary.
-
- -
+
Type
`number`
-
-
Description
-
- The minimum length of a word before checking it against a dictionary. -
-
+ + --- #### `name` {#settings-name} +
-
Name
+ +
Description
- `name` + Optional name of configuration.
-
- -
+
Type
`string`
-
-
Description
-
- Optional name of configuration. -
-
+ + --- #### `noConfigSearch` {#settings-noconfigsearch} +
-
Name
+ +
Description
- `noConfigSearch` + Prevents searching for local configuration when checking individual documents.
-
- -
+
Type
`boolean`
-
-
Description
-
- Prevents searching for local configuration when checking individual documents. -
-
+ + --- #### `noSuggestDictionaries` {#settings-nosuggestdictionaries} +
-
Name
+ +
Description
- `noSuggestDictionaries` + 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`](#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. -
-
+ + --- #### `numSuggestions` {#settings-numsuggestions} +
-
Name
+ +
Description
- `numSuggestions` + Number of suggestions to make.
-
- -
+
Type
`number`
-
-
Description
-
- Number of suggestions to make. -
-
+ + --- #### `overrides` {#settings-overrides} +
-
Name
+ +
Description
- `overrides` + 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`](#overridesettings)`[]`
-
-
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" - } - ] - ``` -
-
+ + --- #### `patterns` {#settings-patterns} +
-
Name
+ +
Description
- `patterns` + 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`](#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. -
-
+ + --- #### `pnpFiles` {#settings-pnpfiles} +
-
Name
+ +
Description
- `pnpFiles` + The PnP files to search for. Note: `.mjs` files are not currently supported.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- The PnP files to search for. Note: `.mjs` files are not currently supported. -
-
+ + --- #### `readonly` {#settings-readonly} +
-
Name
+ +
Description
- `readonly` + 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`
-
-
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. -
-
+ + --- #### `reporters` {#settings-reporters} +
-
Name
+ +
Description
- `reporters` + 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`](#reportersettings)`[]`
-
-
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. -
-
+ + --- #### `showStatus` {#settings-showstatus} +
-
Name
+ +
Description
- `showStatus` + Show status.
-
- -
+
Type
`boolean`
-
-
Description
-
- Show status. -
-
+ + --- #### `spellCheckDelayMs` {#settings-spellcheckdelayms} +
-
Name
+ +
Description
- `spellCheckDelayMs` + Delay in ms after a document has changed before checking it for spelling errors.
-
- -
+
Type
`number`
-
-
Description
-
- Delay in ms after a document has changed before checking it for spelling errors. -
-
+ + --- #### `suggestWords` {#settings-suggestwords} +
-
Name
+ +
Description
- `suggestWords` + 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[]` + `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` -
-
+ + --- #### `suggestionNumChanges` {#settings-suggestionnumchanges} +
-
Name
+ +
Description
- `suggestionNumChanges` + 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. -
-
+ + --- #### `suggestionsTimeout` {#settings-suggestionstimeout} +
-
Name
+ +
Description
- `suggestionsTimeout` + 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. -
-
+ + --- #### `useGitignore` {#settings-usegitignore} +
-
Name
+ +
Description
- `useGitignore` + Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.
-
- -
+
Type
`boolean`
-
-
Description
-
- Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found. -
-
+ + --- #### `usePnP` {#settings-usepnp} +
-
Name
+ +
Description
- `usePnP` + 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. -
-
+ + --- #### `userWords` {#settings-userwords} +
-
Name
+ +
Description
- `userWords` + Words to add to global dictionary -- should only be in the user config file.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- Words to add to global dictionary -- should only be in the user config file. -
-
+ + --- #### `validateDirectives` {#settings-validatedirectives} +
-
Name
+ +
Description
- `validateDirectives` + Verify that the in-document directives are correct.
-
- -
+
Type
`boolean`
-
-
Description
-
- Verify that the in-document directives are correct. -
-
+ + --- #### `version` {#settings-version} +
-
Name
+ +
Description
- `version` + Configuration format version of the settings file. + + This controls how the settings in the configuration file behave.
-
- -
+
Type
- `Version` + [`Version`](#version)
-
-
Description
-
- Configuration format version of the settings file. - - This controls how the settings in the configuration file behave. -
-
+ + --- #### `words` {#settings-words} +
-
Name
+ +
Description
- `words` + List of words to be considered correct.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- List of words to be considered correct. -
-
-## CacheFormat -**Not Handled:** string -## CacheSettings -| Field | Type | Description | -| --------------------------------------------- | ------------------ | ---------------------------------------------------------------------------------- | -| [cacheFormat](#cachesettings-cacheformat) | `CacheFormat` | Format of the cache file. | -| [cacheLocation](#cachesettings-cachelocation) | `FSPathResolvable` | Path to the cache location. Can be a file or a directory. | -| [cacheStrategy](#cachesettings-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 {#cacheformat} ---- - -#### `cacheFormat` {#cachesettings-cacheformat} - -
-
Name
-
- `cacheFormat` -
-
+
Type
- `CacheFormat` + `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. | + + +### CacheSettings Fields + + +--- + +#### `cacheFormat` {#cachesettings-cacheformat} + +
+
Description
Format of the cache file. - - `legacy` - use absolute paths in the cache file - - `universal` - use a sharable format. + - `legacy` - use absolute paths in the cache file + - `universal` - use a sharable format. +
+ +
Type
+
+ [`CacheFormat`](#cacheformat)
+ + + --- #### `cacheLocation` {#cachesettings-cachelocation} +
-
Name
+ +
Description
- `cacheLocation` + 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`](#fspathresolvable)
-
-
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. -
-
+ + --- #### `cacheStrategy` {#cachesettings-cachestrategy} +
-
Name
+ +
Description
- `cacheStrategy` + Strategy to use for detecting changed files, default: metadata
-
- -
+
Type
- `CacheStrategy` + [`CacheStrategy`](#cachestrategy)
+ + + +--- + +#### `useCache` {#cachesettings-usecache} + +
+
Description
- Strategy to use for detecting changed files, default: metadata + Store the results of processed files in order to only operate on the changed ones. +
+ +
Type
+
+ `boolean`
+ + + + --- -#### `useCache` {#cachesettings-usecache} +## CacheStrategy {#cachestrategy} +
-
Name
+ +
Description
- `useCache` + 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
- `boolean` + `string`
+ + + + +--- + +## CharacterSet {#characterset} + +
+
Description
- Store the results of processed files in order to only operate on the changed ones. + 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`
-## CacheStrategy - -**Not Handled:** string - -## CharacterSet -**Not Handled:** string ## CharacterSetCosts -| Field | Type | Description | -| ------------------------------------------- | -------------- | ---------------------------------------------------------------------- | --- | -| [characters](#charactersetcosts-characters) | `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} +
-
Name
+ +
Description
- `characters` + 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`](#characterset)
-
-
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. -
-
+ + --- #### `cost` {#charactersetcosts-cost} +
-
Name
+ +
Description
- `cost` + the cost to insert / delete / replace / swap the characters in a group
-
- -
+
Type
`number`
-
-
Description
-
- the cost to insert / delete / replace / swap the characters in a group -
-
+ + --- #### `penalty` {#charactersetcosts-penalty} +
-
Name
+ +
Description
- `penalty` + The penalty cost to apply if the accent is used. + This is used to discourage
-
- -
+
Type
`number`
-
-
Description
-
- The penalty cost to apply if the accent is used. - 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} +
-
Name
+ +
Description
- `description` + A description to describe the purpose of the map.
-
- -
+
Type
`string`
-
-
Description
-
- A description to describe the purpose of the map. -
-
+ + --- #### `insDel` {#costmapdefinsdel-insdel} +
-
Name
+ +
Description
- `insDel` + The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
-
- -
+
Type
`number`
-
-
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
-
+ + --- #### `map` {#costmapdefinsdel-map} +
-
Name
+ +
Description
- `map` + 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
-
- 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$)"`. -
-
+ + --- #### `penalty` {#costmapdefinsdel-penalty} +
-
Name
+ +
Description
- `penalty` + 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`
-
-
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. -
-
+ + --- #### `replace` {#costmapdefinsdel-replace} +
-
Name
+ +
Description
- `replace` + 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
-
- 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. -
-
+ + --- #### `swap` {#costmapdefinsdel-swap} +
-
Name
+ +
Description
- `swap` + 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
-
- 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. -
-
+ ## 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} +
-
Name
+ +
Description
- `description` + A description to describe the purpose of the map.
-
- -
+
Type
`string`
-
-
Description
-
- A description to describe the purpose of the map. -
-
+ + --- #### `insDel` {#costmapdefreplace-insdel} +
-
Name
+ +
Description
- `insDel` + The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
-
- -
+
Type
`number`
-
-
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
-
+ + --- #### `map` {#costmapdefreplace-map} +
-
Name
+ +
Description
- `map` + 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
-
- 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$)"`. -
-
+ + --- #### `penalty` {#costmapdefreplace-penalty} +
-
Name
+ +
Description
- `penalty` + 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`
-
-
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. -
-
+ + --- #### `replace` {#costmapdefreplace-replace} +
-
Name
+ +
Description
- `replace` + 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
-
- 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. -
-
+ + --- #### `swap` {#costmapdefreplace-swap} +
-
Name
+ +
Description
- `swap` + 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
-
- 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. -
-
+ ## 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} +
-
Name
+ +
Description
- `description` + A description to describe the purpose of the map.
-
- -
+
Type
`string`
-
-
Description
-
- A description to describe the purpose of the map. -
-
+ + --- #### `insDel` {#costmapdefswap-insdel} +
-
Name
+ +
Description
- `insDel` + The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
-
- -
+
Type
`number`
-
-
Description
-
- The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical. -
-
+ + --- #### `map` {#costmapdefswap-map} +
-
Name
+ +
Description
- `map` + 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
-
- 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$)"`. -
-
+ + --- #### `penalty` {#costmapdefswap-penalty} +
-
Name
+ +
Description
- `penalty` + 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`
-
-
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. -
-
+ + --- #### `replace` {#costmapdefswap-replace} +
-
Name
+ +
Description
- `replace` + 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 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. + 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`
+ + + + --- -#### `swap` {#costmapdefswap-swap} +## CustomDictionaryPath {#customdictionarypath} +
-
Name
+ +
Description
- `swap` + A File System Path to a dictionary file.
-
- -
+
Type
- `number` + [`FsDictionaryPath`](#fsdictionarypath)
+ + + + +--- + +## CustomDictionaryScope {#customdictionaryscope} + +
+
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. + Specifies the scope of a dictionary. +
+ +
Type
+
+ `string`
-## CustomDictionaryPath -**Not Handled:** undefined -## CustomDictionaryScope -**Not Handled:** string -## DictionaryDefinition +--- + +## DictionaryDefinition {#dictionarydefinition} + + +
+ +
Type
+
+ [`DictionaryDefinitionPreferred`](#dictionarydefinitionpreferred)
[`DictionaryDefinitionCustom`](#dictionarydefinitioncustom)
[`DictionaryDefinitionAugmented`](#dictionarydefinitionaugmented)
[`DictionaryDefinitionInline`](#dictionarydefinitioninline)
[`DictionaryDefinitionAlternate`](#dictionarydefinitionalternate) +
+
+ -**Not Handled:** undefined ## DictionaryDefinitionAlternate -| Field | Type | Description | -| ----------------------------------------------------------- | --------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionalternate-description) | `string` | Optional description. | -| [file](#dictionarydefinitionalternate-file) | `DictionaryPath` | Path to the file, only for legacy dictionary definitions. | -| [name](#dictionarydefinitionalternate-name) | `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` | Replacement pairs. | -| [type](#dictionarydefinitionalternate-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `file` {#dictionarydefinitionalternate-file} +
-
Name
+ +
Description
- `file` + Path to the file, only for legacy dictionary definitions.
-
- -
+
Type
- `DictionaryPath` + [`DictionaryPath`](#dictionarypath)
-
-
Description
-
- Path to the file, only for legacy dictionary definitions. -
-
+ + --- #### `name` {#dictionarydefinitionalternate-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitionalternate-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `repMap` {#dictionarydefinitionalternate-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `type` {#dictionarydefinitionalternate-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitionalternate-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
-
-
Description
-
- Use Compounds. -
-
+ ## DictionaryDefinitionAugmented -| Field | Type | Description | -| ----------------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionaugmented-description) | `string` | Optional description. | -| [dictionaryInformation](#dictionarydefinitionaugmented-dictionaryinformation) | `DictionaryInformation` | | -| [name](#dictionarydefinitionaugmented-name) | `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` | Path to the file. | -| [repMap](#dictionarydefinitionaugmented-repmap) | `ReplaceMap` | Replacement pairs. | -| [type](#dictionarydefinitionaugmented-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `dictionaryInformation` {#dictionarydefinitionaugmented-dictionaryinformation} -
-
Name
-
- `dictionaryInformation` -
-
+
Type
- `DictionaryInformation` + [`DictionaryInformation`](#dictionaryinformation)
-
-
Description
-
- -
-
+ + --- #### `name` {#dictionarydefinitionaugmented-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitionaugmented-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `path` {#dictionarydefinitionaugmented-path} +
-
Name
+ +
Description
- `path` + Path to the file.
-
- -
+
Type
- `DictionaryPath` + [`DictionaryPath`](#dictionarypath)
-
-
Description
-
- Path to the file. -
-
+ + --- #### `repMap` {#dictionarydefinitionaugmented-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `type` {#dictionarydefinitionaugmented-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitionaugmented-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
-
-
Description
-
- 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` | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioncustom-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [path](#dictionarydefinitioncustom-path) | `CustomDictionaryPath` | Path to custom dictionary text file. | -| [repMap](#dictionarydefinitioncustom-repmap) | `ReplaceMap` | Replacement pairs. | -| [scope](#dictionarydefinitioncustom-scope) | `CustomDictionaryScope`
`CustomDictionaryScope[]` | Defines the scope for when words will be added to the dictionary. | -| [type](#dictionarydefinitioncustom-type) | `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} +
-
Name
+ +
Description
- `addWords` + When `true`, let's the spell checker know that words can be added to this dictionary.
-
- -
+
Type
`boolean`
-
-
Description
-
- When `true`, let's the spell checker know that words can be added to this dictionary. -
-
+ + --- #### `description` {#dictionarydefinitioncustom-description} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `name` {#dictionarydefinitioncustom-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitioncustom-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `path` {#dictionarydefinitioncustom-path} +
-
Name
+ +
Description
- `path` + Path to custom dictionary text file.
-
- -
+
Type
- `CustomDictionaryPath` + [`CustomDictionaryPath`](#customdictionarypath)
-
-
Description
-
- Path to custom dictionary text file. -
-
+ + --- #### `repMap` {#dictionarydefinitioncustom-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `scope` {#dictionarydefinitioncustom-scope} +
-
Name
+ +
Description
- `scope` + Defines the scope for when words will be added to the dictionary. + + Scope values: `user`, `workspace`, `folder`.
-
- -
+
Type
- `CustomDictionaryScope`
`CustomDictionaryScope[]` + [`CustomDictionaryScope`](#customdictionaryscope)
[`CustomDictionaryScope`](#customdictionaryscope)`[]`
-
-
Description
-
- Defines the scope for when words will be added to the dictionary. - - Scope values: `user`, `workspace`, `folder`. -
-
+ + --- #### `type` {#dictionarydefinitioncustom-type} -
-
Name
-
- `type` -
-
-
Type
+ +
Description
- `DictionaryFileTypes` + Type of file: + - S - single word per line, + - W - each line can contain one or more words separated by space, + - C - each line is treated like code (Camel Case is allowed). + + Default is S. + + C is the slowest to load due to the need to split each line based upon code splitting rules.
-
- -
-
Description
+ +
Type
- 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. + [`DictionaryFileTypes`](#dictionaryfiletypes)
+ + + --- #### `useCompounds` {#dictionarydefinitioncustom-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
+ + + + +--- + +## DictionaryDefinitionInline {#dictionarydefinitioninline} + +
+
Description
- Use Compounds. + Inline Dictionary Definitions +
+ +
Type
+
+ [`DictionaryDefinitionInlineWords`](#dictionarydefinitioninlinewords)
[`DictionaryDefinitionInlineIgnoreWords`](#dictionarydefinitioninlineignorewords)
[`DictionaryDefinitionInlineFlagWords`](#dictionarydefinitioninlineflagwords)
-## DictionaryDefinitionInline -**Not Handled:** undefined ## 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` | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineflagwords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineflagwords-repmap) | `ReplaceMap` | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineflagwords-suggestwords) | `string[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineflagwords-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `flagWords` {#dictionarydefinitioninlineflagwords-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `ignoreWords` {#dictionarydefinitioninlineflagwords-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `name` {#dictionarydefinitioninlineflagwords-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitioninlineflagwords-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `repMap` {#dictionarydefinitioninlineflagwords-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `suggestWords` {#dictionarydefinitioninlineflagwords-suggestwords} +
-
Name
+ +
Description
- `suggestWords` + 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[]` + `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` {#dictionarydefinitioninlineflagwords-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitioninlineflagwords-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
-
-
Description
-
- Use Compounds. -
-
+ + --- #### `words` {#dictionarydefinitioninlineflagwords-words} +
-
Name
+ +
Description
- `words` + List of words to be considered correct.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- List of words to be considered correct. -
-
+ ## 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` | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlineignorewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlineignorewords-repmap) | `ReplaceMap` | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlineignorewords-suggestwords) | `string[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlineignorewords-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `flagWords` {#dictionarydefinitioninlineignorewords-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `ignoreWords` {#dictionarydefinitioninlineignorewords-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `name` {#dictionarydefinitioninlineignorewords-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitioninlineignorewords-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `repMap` {#dictionarydefinitioninlineignorewords-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `suggestWords` {#dictionarydefinitioninlineignorewords-suggestwords} +
-
Name
+ +
Description
- `suggestWords` + 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[]` + `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` {#dictionarydefinitioninlineignorewords-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitioninlineignorewords-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
-
-
Description
-
- Use Compounds. -
-
+ + --- #### `words` {#dictionarydefinitioninlineignorewords-words} +
-
Name
+ +
Description
- `words` + List of words to be considered correct.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- List of words to be considered correct. -
-
+ ## 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` | This is the name of a dictionary. | -| [noSuggest](#dictionarydefinitioninlinewords-nosuggest) | `boolean` | Indicate that suggestions should not come from this dictionary. | -| [repMap](#dictionarydefinitioninlinewords-repmap) | `ReplaceMap` | Replacement pairs. | -| [suggestWords](#dictionarydefinitioninlinewords-suggestwords) | `string[]` | A list of suggested replacements for words. | -| [type](#dictionarydefinitioninlinewords-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `flagWords` {#dictionarydefinitioninlinewords-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `ignoreWords` {#dictionarydefinitioninlinewords-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `name` {#dictionarydefinitioninlinewords-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitioninlinewords-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `repMap` {#dictionarydefinitioninlinewords-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `suggestWords` {#dictionarydefinitioninlinewords-suggestwords} +
-
Name
+ +
Description
- `suggestWords` + 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[]` + `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` {#dictionarydefinitioninlinewords-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitioninlinewords-usecompounds} +
-
Name
+ +
Description
- `useCompounds` + Use Compounds.
-
- -
+
Type
`boolean`
-
-
Description
-
- Use Compounds. -
-
+ + --- #### `words` {#dictionarydefinitioninlinewords-words} +
-
Name
+ +
Description
- `words` + List of words to be considered correct.
-
- -
+
Type
- `string[]` + `string``[]`
-
-
Description
-
- List of words to be considered correct. -
-
+ ## DictionaryDefinitionPreferred -| Field | Type | Description | -| ----------------------------------------------------------- | --------------------- | --------------------------------------------------------------- | -| [description](#dictionarydefinitionpreferred-description) | `string` | Optional description. | -| [name](#dictionarydefinitionpreferred-name) | `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` | Path to the file. | -| [repMap](#dictionarydefinitionpreferred-repmap) | `ReplaceMap` | Replacement pairs. | -| [type](#dictionarydefinitionpreferred-type) | `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} +
-
Name
+ +
Description
- `description` + Optional description.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description. -
-
+ + --- #### `name` {#dictionarydefinitionpreferred-name} +
-
Name
+ +
Description
- `name` + 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`](#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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`. -
-
+ + --- #### `noSuggest` {#dictionarydefinitionpreferred-nosuggest} +
-
Name
+ +
Description
- `noSuggest` + 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
-
- 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. -
-
+ + --- #### `path` {#dictionarydefinitionpreferred-path} +
-
Name
+ +
Description
- `path` + Path to the file.
-
- -
+
Type
- `DictionaryPath` + [`DictionaryPath`](#dictionarypath)
-
-
Description
-
- Path to the file. -
-
+ + --- #### `repMap` {#dictionarydefinitionpreferred-repmap} +
-
Name
+ +
Description
- `repMap` + Replacement pairs.
-
- -
+
Type
- `ReplaceMap` + [`ReplaceMap`](#replacemap)
-
-
Description
-
- Replacement pairs. -
-
+ + --- #### `type` {#dictionarydefinitionpreferred-type} +
-
Name
+ +
Description
- `type` + 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`](#dictionaryfiletypes)
-
-
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. -
-
+ + --- #### `useCompounds` {#dictionarydefinitionpreferred-usecompounds} +
-
Name
+ +
Description
+
+ Use Compounds. +
+ +
Type
- `useCompounds` + `boolean`
+ + + + +--- + +## DictionaryFileTypes {#dictionaryfiletypes} + +
+
Type
- `boolean` + `string`
+ + + + +--- + +## DictionaryId {#dictionaryid} + +
+
Description
- Use Compounds. + 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`
-## DictionaryFileTypes -**Not Handled:** string - -## DictionaryId - -**Not Handled:** string ## DictionaryInformation -| Field | Type | Description | -| ----------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------- | -| [accents](#dictionaryinformation-accents) | `CharacterSet`
`CharacterSetCosts[]` | The accent characters. | -| [adjustments](#dictionaryinformation-adjustments) | `PatternAdjustment[]` | A collection of patterns to test against the suggested words. | -| [alphabet](#dictionaryinformation-alphabet) | `CharacterSet`
`CharacterSetCosts[]` | The alphabet to use. | -| [costs](#dictionaryinformation-costs) | `EditCosts` | Define edit costs. | -| [hunspellInformation](#dictionaryinformation-hunspellinformation) | `HunspellInformation` | Used by dictionary authors | -| [ignore](#dictionaryinformation-ignore) | `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` | 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} +
-
Name
+ +
Description
- `accents` + The accent characters. + + Default: `"\u0300-\u0341"`
-
- -
+
Type
- `CharacterSet`
`CharacterSetCosts[]` + [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]`
-
-
Description
-
- The accent characters. - - Default: `"\u0300-\u0341"` -
-
+ + --- #### `adjustments` {#dictionaryinformation-adjustments} +
-
Name
+ +
Description
- `adjustments` + A collection of patterns to test against the suggested words. + If the word matches the pattern, then the penalty is applied.
-
- -
+
Type
- `PatternAdjustment[]` + [`PatternAdjustment`](#patternadjustment)`[]`
-
-
Description
-
- A collection of patterns to test against the suggested words. - If the word matches the pattern, then the penalty is applied. -
-
+ + --- #### `alphabet` {#dictionaryinformation-alphabet} +
-
Name
+ +
Description
- `alphabet` + The alphabet to use.
-
- -
+
Type
- `CharacterSet`
`CharacterSetCosts[]` + [`CharacterSet`](#characterset)
[`CharacterSetCosts`](#charactersetcosts)`[]`
-
-
Description
-
- The alphabet to use. -
-
+ + --- #### `costs` {#dictionaryinformation-costs} +
-
Name
+ +
Description
- `costs` + Define edit costs.
-
- -
+
Type
- `EditCosts` + [`EditCosts`](#editcosts)
-
-
Description
-
- Define edit costs. -
-
+ + --- #### `hunspellInformation` {#dictionaryinformation-hunspellinformation} +
-
Name
+ +
Description
- `hunspellInformation` + Used by dictionary authors
-
- -
+
Type
- `HunspellInformation` + [`HunspellInformation`](#hunspellinformation)
-
-
Description
-
- Used by dictionary authors -
-
+ + --- #### `ignore` {#dictionaryinformation-ignore} +
-
Name
+ +
Description
- `ignore` + 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`](#characterset)
-
-
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. -
-
+ + --- #### `locale` {#dictionaryinformation-locale} +
-
Name
+ +
Description
- `locale` + The locale of the dictionary. + Example: `nl,nl-be`
-
- -
+
Type
`string`
-
-
Description
-
- The locale of the dictionary. - Example: `nl,nl-be` -
-
+ + --- #### `suggestionEditCosts` {#dictionaryinformation-suggestioneditcosts} +
-
Name
+ +
Description
- `suggestionEditCosts` + 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`](#suggestioncostsdefs)
-
-
Description
-
- Used in making suggestions. The lower the value, the more likely the suggestion - will be near the top of the suggestion list. -
-
-## DictionaryNegRef -**Not Handled:** string -## DictionaryPath -**Not Handled:** string +--- -## DictionaryRef +## DictionaryNegRef {#dictionarynegref} -**Not Handled:** undefined -## DictionaryReference +
+ +
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` +
+
-**Not Handled:** undefined -## 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} +## DictionaryPath {#dictionarypath} +
-
Name
+ +
Description
- `accentCosts` + A File System Path to a dictionary file. + Pattern: `^.*\.(?:txt|trie|dic)(?:\.gz)?$`
-
- -
+
Type
- `number` + `string`
-
-
Description
-
- The cost to add / remove an accent - This should be very cheap, it helps with fixing accent issues. -
-
+ + + --- -#### `baseCost` {#editcosts-basecost} +## DictionaryRef {#dictionaryref} +
-
Name
+ +
Description
- `baseCost` + This a reference to a named dictionary. + It is expected to match the name of a dictionary.
-
- -
+
Type
- `number` + [`DictionaryId`](#dictionaryid)
-
-
Description
-
- This is the base cost for making an edit. -
-
+ + + --- -#### `capsCosts` {#editcosts-capscosts} +## DictionaryReference {#dictionaryreference} +
-
Name
+ +
Description
- `capsCosts` + Reference to a dictionary by name. + One of: + - [DictionaryRef](#dictionaryref) + - [DictionaryNegRef](#dictionarynegref)
-
- -
+
Type
- `number` + [`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 change capitalization. - This should be very cheap, it helps with fixing capitalization issues. + The cost to add / remove an accent + This should be very cheap, it helps with fixing accent issues. +
+ +
Type
+
+ `number`
+ + + --- -#### `firstLetterPenalty` {#editcosts-firstletterpenalty} +#### `baseCost` {#editcosts-basecost} +
-
Name
+ +
Description
+
+ This is the base cost for making an edit. +
+ +
Type
- `firstLetterPenalty` + `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`. + This value should be less than `100 - baseCost`. +
+ +
Type
+
+ `number`
+ + + --- #### `nonAlphabetCosts` {#editcosts-nonalphabetcosts} +
-
Name
+ +
Description
- `nonAlphabetCosts` + This is the cost for characters not in the alphabet.
-
- -
+
Type
`number`
+ + + + +--- + +## FSPathResolvable {#fspathresolvable} + +
+
Description
- This is the cost for characters not in the alphabet. + 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)
-## FSPathResolvable -**Not Handled:** undefined -## FeatureEnableOnly -**Not Handled:** boolean + +--- + +## FeatureEnableOnly {#featureenableonly} + + +
+ +
Type
+
+ `boolean` +
+
+ + ## Features -| Field | Type | Description | -| ------------------------------------------------------ | ------------------- | ------------------------------------------ | -| [weighted-suggestions](#features-weighted-suggestions) | `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} +
-
Name
+ +
Description
- `weighted-suggestions` + Enable/disable using weighted suggestions. +
+ +
Type
+
+ [`FeatureEnableOnly`](#featureenableonly)
+ + + + +--- + +## FsDictionaryPath {#fsdictionarypath} + +
+ +
Description
+
+ A File System Path. Relative paths are relative to the configuration file. +
+
Type
- `FeatureEnableOnly` + `string`
+ + + + +--- + +## FsPath {#fspath} + +
+
Description
- Enable/disable using weighted suggestions. + A File System Path. Relative paths are relative to the configuration file. +
+ +
Type
+
+ `string`
-## FsDictionaryPath -**Not Handled:** string -## FsPath -**Not Handled:** string -## Glob +--- + +## Glob {#glob} + + +
+ +
Description
+
+ These are glob expressions. +
+ +
Type
+
+ [`SimpleGlob`](#simpleglob) +
+
+ -**Not Handled:** undefined ## 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} +
-
Name
+ +
Description
- `aff` + 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
- 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) - ``` + The costs to apply when using the hunspell settings +
+ +
Type
+
+ `object`
+ + + + --- -#### `costs` {#hunspellinformation-costs} +## LanguageId {#languageid} +
-
Name
+ +
Type
- `costs` + [`LanguageIdSingle`](#languageidsingle)
[`LanguageIdMultiple`](#languageidmultiple)
[`LanguageIdMultipleNeg`](#languageidmultipleneg)
+ + + + +--- + +## LanguageIdMultiple {#languageidmultiple} + +
+ +
Description
+
+ This can be 'typescript,cpp,json,literal haskell', etc. +
+
Type
- `object` + `string`
+ + + + +--- + +## LanguageIdMultipleNeg {#languageidmultipleneg} + +
+
Description
- The costs to apply when using the hunspell settings + This can be 'typescript,cpp,json,literal haskell', etc. +
+ +
Type
+
+ `string`
-## LanguageId -**Not Handled:** undefined -## LanguageIdMultiple -**Not Handled:** string -## LanguageIdMultipleNeg +--- + +## LanguageIdSingle {#languageidsingle} + -**Not Handled:** string +
+ +
Description
+
+ This can be '*', 'typescript', 'cpp', 'json', etc. +
+ +
Type
+
+ `string` +
+
-## LanguageIdSingle -**Not Handled:** 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[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#languagesetting-dictionarydefinitions) | `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` | 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` | List of regular expression patterns or defined pattern names to match for spell checking. | -| [languageId](#languagesetting-languageid) | `MatchingFileType` | The language id. Ex: "typescript", "html", or "php". "\*" -- will match all languages. | -| [local](#languagesetting-local) | `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[]` | 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[]` | Optional list of dictionaries that will not be used for suggestions. | -| [patterns](#languagesetting-patterns) | `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} +
-
Name
+ +
Description
- `allowCompoundWords` + 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. -
-
+ + --- #### `caseSensitive` {#languagesetting-casesensitive} +
-
Name
+ +
Description
- `caseSensitive` + 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. -
-
+ + --- #### `description` {#languagesetting-description} +
-
Name
+ +
Description
- `description` + Optional description of configuration.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description of configuration. -
-
+ + --- #### `dictionaries` {#languagesetting-dictionaries} -
-
Name
-
- `dictionaries` -
-
- -
-
Type
-
- `DictionaryReference[]` -
-
+
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. + + 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} +
-
Name
+ +
Description
- `dictionaryDefinitions` + 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`](#dictionarydefinition)`[]`
-
-
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"] - ``` -
-
+ + --- #### `enabled` {#languagesetting-enabled} +
-
Name
+ +
Description
- `enabled` + Is the spell checker enabled.
-
- -
+
Type
`boolean`
-
-
Description
-
- Is the spell checker enabled. -
-
+ + --- #### `flagWords` {#languagesetting-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `id` {#languagesetting-id} +
-
Name
+ +
Description
- `id` + Optional identifier.
-
- -
+
Type
`string`
-
-
Description
-
- Optional identifier. -
-
+ + --- #### `ignoreRegExpList` {#languagesetting-ignoreregexplist} +
-
Name
+ +
Description
- `ignoreRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `ignoreWords` {#languagesetting-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `includeRegExpList` {#languagesetting-includeregexplist} +
-
Name
+ +
Description
- `includeRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `languageId` {#languagesetting-languageid} +
-
Name
+ +
Description
- `languageId` + The language id. Ex: "typescript", "html", or "php". "*" -- will match all languages.
-
- -
+
Type
- `MatchingFileType` + [`MatchingFileType`](#matchingfiletype)
-
-
Description
-
- The language id. Ex: "typescript", "html", or "php". "*" -- will match all languages. -
-
+ + --- #### `local` {#languagesetting-local} +
-
Name
+ +
Description
- `local` + Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
-
- -
+
Type
- `LocaleId`
`LocaleId[]` + [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]`
-
-
Description
-
- Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. -
-
+ + --- #### `locale` {#languagesetting-locale} +
-
Name
+ +
Description
- `locale` + The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
-
- -
+
Type
- `LocaleId`
`LocaleId[]` + [`LocaleId`](#localeid)
[`LocaleId`](#localeid)`[]`
-
-
Description
-
- The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. -
-
+ + --- #### `name` {#languagesetting-name} +
-
Name
+ +
Description
- `name` + Optional name of configuration.
-
- -
+
Type
`string`
-
-
Description
-
- Optional name of configuration. -
-
+ + --- #### `noSuggestDictionaries` {#languagesetting-nosuggestdictionaries} +
-
Name
+ +
Description
- `noSuggestDictionaries` + 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`](#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. -
-
+ + --- #### `patterns` {#languagesetting-patterns} +
-
Name
+ +
Description
- `patterns` + 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`](#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. -
-
+ + --- #### `suggestWords` {#languagesetting-suggestwords} +
-
Name
+ +
Description
- `suggestWords` + 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[]` + `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` -
-
+ + --- #### `words` {#languagesetting-words} +
-
Name
+ +
Description
- `words` + List of words to be considered correct.
-
- -
+
Type
- `string[]` + `string``[]`
+ + + + +--- + +## LocaleId {#localeid} + +
+
Description
- List of words to be considered correct. + This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. +
+ +
Type
+
+ `string`
-## LocaleId -**Not Handled:** string -## MatchingFileType -**Not Handled:** undefined - -## 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[]` | Optional list of dictionaries to use. Each entry should match the name of the dictionary. | -| [dictionaryDefinitions](#overridesettings-dictionarydefinitions) | `DictionaryDefinition[]` | Define additional available dictionaries. | -| [enableFiletypes](#overridesettings-enablefiletypes) | `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[]` | 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 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` | 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` | List of regular expression patterns or defined pattern names to match for spell checking. | -| [language](#overridesettings-language) | `LocaleId` | Sets the locale. | -| [languageId](#overridesettings-languageid) | `MatchingFileType` | Sets the programming language id to match file type. | -| [languageSettings](#overridesettings-languagesettings) | `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[]` | Optional list of dictionaries that will not be used for suggestions. | -| [numSuggestions](#overridesettings-numsuggestions) | `number` | Number of suggestions to make. | -| [patterns](#overridesettings-patterns) | `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} +## MatchingFileType {#matchingfiletype} +
-
Name
+ +
Type
- `allowCompoundWords` + [`LanguageId`](#languageid)
[`LanguageId`](#languageid)`[]`
-
-
Type
-
- `boolean` -
-
+ + +## 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. | + + +### OverrideSettings Fields + + +--- + +#### `allowCompoundWords` {#overridesettings-allowcompoundwords} +
+
Description
True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
+ +
Type
+
+ `boolean` +
+ + + --- #### `caseSensitive` {#overridesettings-casesensitive} +
-
Name
+ +
Description
- `caseSensitive` + 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. -
-
+ + --- #### `description` {#overridesettings-description} +
-
Name
+ +
Description
- `description` + Optional description of configuration.
-
- -
+
Type
`string`
-
-
Description
-
- Optional description of configuration. -
-
+ + --- #### `dictionaries` {#overridesettings-dictionaries} +
-
Name
+ +
Description
- `dictionaries` + 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`](#dictionaryreference)`[]`
-
-
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. -
-
+ + --- #### `dictionaryDefinitions` {#overridesettings-dictionarydefinitions} +
-
Name
+ +
Description
- `dictionaryDefinitions` + 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`](#dictionarydefinition)`[]`
-
-
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"] - ``` -
-
+ + --- #### `enableFiletypes` {#overridesettings-enablefiletypes} +
-
Name
+ +
Description
- `enableFiletypes` + 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`](#languageidsingle)`[]`
-
-
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 - ``` -
-
+ + --- #### `enabled` {#overridesettings-enabled} +
-
Name
+ +
Description
- `enabled` + Is the spell checker enabled.
-
- -
+
Type
`boolean`
-
-
Description
-
- Is the spell checker enabled. -
-
+ + --- #### `enabledFileTypes` {#overridesettings-enabledfiletypes} +
-
Name
+ +
Description
- `enabledFileTypes` + 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`
-
-
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. | -
-
+ + --- #### `enabledLanguageIds` {#overridesettings-enabledlanguageids} +
-
Name
+ +
Description
- `enabledLanguageIds` + 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`](#languageidsingle)`[]`
-
-
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. -
-
+ + --- #### `filename` {#overridesettings-filename} +
-
Name
+ +
Description
- `filename` + Glob pattern or patterns to match against.
-
- -
+
Type
- `Glob`
`Glob[]` + [`Glob`](#glob)
[`Glob`](#glob)`[]`
-
-
Description
-
- Glob pattern or patterns to match against. -
-
+ + --- #### `flagWords` {#overridesettings-flagwords} +
-
Name
+ +
Description
- `flagWords` + 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[]` + `string``[]`
-
-
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" - ] - ``` -
-
+ + --- #### `id` {#overridesettings-id} +
-
Name
+ +
Description
- `id` + Optional identifier.
-
- -
+
Type
`string`
-
-
Description
-
- Optional identifier. -
-
+ + --- #### `ignoreRegExpList` {#overridesettings-ignoreregexplist} +
-
Name
+ +
Description
- `ignoreRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `ignoreWords` {#overridesettings-ignorewords} +
-
Name
+ +
Description
- `ignoreWords` + 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[]` + `string``[]`
-
-
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`. -
-
+ + --- #### `includeRegExpList` {#overridesettings-includeregexplist} +
-
Name
+ +
Description
- `includeRegExpList` + 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`](#regexppatternlist)
-
-
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). -
-
+ + --- #### `language` {#overridesettings-language} +
-
Name
+ +
Description
- `language` + Sets the locale.
-
- -
+
Type
- `LocaleId` + [`LocaleId`](#localeid)
+ + + +--- + +#### `languageId` {#overridesettings-languageid} + +
+
Description
- Sets the locale. + Sets the programming language id to match file type. +
+ +
Type
+
+ [`MatchingFileType`](#matchingfiletype)
+ + + --- -#### `languageId` {#overridesettings-languageid} +#### `languageSettings` {#overridesettings-languagesettings} +
-
Name
+ +
Description
- `languageId` + Additional settings for individual languages. + + See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
-
- -
+
Type
- `MatchingFileType` + [`LanguageSetting`](#languagesetting)`[]`
+ + + +--- + +#### `loadDefaultConfiguration` {#overridesettings-loaddefaultconfiguration} + +
+
Description
- Sets the programming language id to match file type. + By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` + will prevent ALL default configuration from being loaded. +
+ +
Type
+
+ `boolean`
+ + + --- -#### `languageSettings` {#overridesettings-languagesettings} +#### `maxDuplicateProblems` {#overridesettings-maxduplicateproblems} +
-
Name
+ +
Description
- `languageSettings` + The maximum number of times the same word can be flagged as an error in a file.
-
- -
+
Type
- `LanguageSetting[]` + `number`
+ + + +--- + +#### `maxNumberOfProblems` {#overridesettings-maxnumberofproblems} + +
+
Description
- Additional settings for individual languages. - - See [Language Settings](https://cspell.org/configuration/language-settings/) for more details. + The maximum number of problems to report in a file. +
+ +
Type
+
+ `number`
+ + + --- -#### `loadDefaultConfiguration` {#overridesettings-loaddefaultconfiguration} +#### `minWordLength` {#overridesettings-minwordlength} +
-
Name
+ +
Description
- `loadDefaultConfiguration` + The minimum length of a word before checking it against a dictionary.
-
- -
+
Type
- `boolean` + `number`
+ + + +--- + +#### `name` {#overridesettings-name} + +
+
Description
- By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` - will prevent ALL default configuration from being loaded. + Optional name of configuration. +
+ +
Type
+
+ `string`
+ + + --- -#### `maxDuplicateProblems` {#overridesettings-maxduplicateproblems} +#### `noSuggestDictionaries` {#overridesettings-nosuggestdictionaries} +
-
Name
+ +
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
- `maxDuplicateProblems` + [`DictionaryReference`](#dictionaryreference)`[]`
+ + + +--- + +#### `numSuggestions` {#overridesettings-numsuggestions} + +
+ +
Description
+
+ Number of suggestions to make. +
+
Type
`number`
+ + + +--- + +#### `patterns` {#overridesettings-patterns} + +
+
Description
- The maximum number of times the same word can be flagged as an error in a file. + 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)`[]`
+ + + --- -#### `maxNumberOfProblems` {#overridesettings-maxnumberofproblems} +#### `pnpFiles` {#overridesettings-pnpfiles} +
-
Name
+ +
Description
- `maxNumberOfProblems` + The PnP files to search for. Note: `.mjs` files are not currently supported.
-
- -
+
Type
- `number` + `string``[]`
+ + + +--- + +#### `suggestWords` {#overridesettings-suggestwords} + +
+
Description
- The maximum number of problems to report in a file. + 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``[]`
+ + + --- -#### `minWordLength` {#overridesettings-minwordlength} +#### `suggestionNumChanges` {#overridesettings-suggestionnumchanges} +
-
Name
+ +
Description
- `minWordLength` + 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`
+ + + +--- + +#### `suggestionsTimeout` {#overridesettings-suggestionstimeout} + +
+
Description
- The minimum length of a word before checking it against a dictionary. + The maximum amount of time in milliseconds to generate suggestions for a word. +
+ +
Type
+
+ `number`
+ + + --- -#### `name` {#overridesettings-name} +#### `usePnP` {#overridesettings-usepnp} +
-
Name
+ +
Description
- `name` + 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
- `string` + `boolean`
+ + + +--- + +#### `words` {#overridesettings-words} + +
+
Description
- Optional name of configuration. + List of words to be considered correct. +
+ +
Type
+
+ `string``[]`
+ + + + --- -#### `noSuggestDictionaries` {#overridesettings-nosuggestdictionaries} +## Pattern {#pattern} +
-
Name
+ +
Type
- `noSuggestDictionaries` + `string`
+ + +## 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 | + + +### PatternAdjustment Fields + + +--- + +#### `id` {#patternadjustment-id} + +
+ +
Description
+
+ Id of the Adjustment, i.e. `short-compound` +
+
Type
- `DictionaryReference[]` + `string`
+ + + +--- + +#### `penalty` {#patternadjustment-penalty} + +
+
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. + The amount of penalty to apply. +
+ +
Type
+
+ `number`
+ + + --- -#### `numSuggestions` {#overridesettings-numsuggestions} +#### `regexp` {#patternadjustment-regexp} +
-
Name
+ +
Description
- `numSuggestions` + RegExp pattern to match
-
- -
+
Type
- `number` + `string`
+ + + + +--- + +## PatternId {#patternid} + +
+
Description
- Number of suggestions to make. + This matches the name in a pattern definition. +
+ +
Type
+
+ `string`
+ + + + --- -#### `patterns` {#overridesettings-patterns} +## PatternRef {#patternref} +
-
Name
+ +
Description
- `patterns` + A PatternRef is a Pattern or PatternId.
-
- -
+
Type
- `RegExpPatternDefinition[]` + [`Pattern`](#pattern)
[`PatternId`](#patternid)
[`PredefinedPatterns`](#predefinedpatterns)
-
-
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. -
-
+ + + --- -#### `pnpFiles` {#overridesettings-pnpfiles} +## PredefinedPatterns {#predefinedpatterns} -
-
Name
-
- `pnpFiles` -
-
+
Type
- `string[]` + `string`
-
-
Description
-
- The PnP files to search for. Note: `.mjs` files are not currently supported. -
-
+ + +## 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. | + + +### RegExpPatternDefinition Fields + --- -#### `suggestWords` {#overridesettings-suggestwords} +#### `description` {#regexppatterndefinition-description} +
-
Name
+ +
Description
- `suggestWords` + Description of the pattern.
-
- -
+
Type
- `string[]` + `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` -
-
+ + --- -#### `suggestionNumChanges` {#overridesettings-suggestionnumchanges} +#### `name` {#regexppatterndefinition-name} +
-
Name
+ +
Description
- `suggestionNumChanges` + 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
- `number` + [`PatternId`](#patternid)
-
-
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. -
-
+ + --- -#### `suggestionsTimeout` {#overridesettings-suggestionstimeout} +#### `pattern` {#regexppatterndefinition-pattern} +
-
Name
+ +
Description
- `suggestionsTimeout` + RegExp pattern or array of RegExp patterns.
-
- -
+
Type
- `number` + [`Pattern`](#pattern)
[`Pattern`](#pattern)`[]`
-
-
Description
-
- The maximum amount of time in milliseconds to generate suggestions for a word. -
-
+ + + --- -#### `usePnP` {#overridesettings-usepnp} +## RegExpPatternList {#regexppatternlist} +
-
Name
+ +
Description
- `usePnP` + A list of pattern names or regular expressions.
-
- -
+
Type
- `boolean` + [`PatternRef`](#patternref)`[]`
-
-
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. -
-
+ + + --- -#### `words` {#overridesettings-words} +## ReplaceEntry {#replaceentry} -
-
Name
-
- `words` -
-
+
Type
- `string[]` + `string``[]`
+ + + + +--- + +## ReplaceMap {#replacemap} + +
-
Description
+ +
Type
- List of words to be considered correct. + [`ReplaceEntry`](#replaceentry)`[]`
-## Pattern - -**Not Handled:** string -## 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 | -### PatternAdjustment Fields --- -#### `id` {#patternadjustment-id} +## ReporterModuleName {#reportermodulename} +
-
Name
+ +
Description
- `id` + The module or path to the the reporter to load.
-
- -
+
Type
`string`
-
-
Description
-
- Id of the Adjustment, i.e. `short-compound` -
-
+ + + --- -#### `penalty` {#patternadjustment-penalty} +## ReporterOptions {#reporteroptions} +
-
Name
+ +
Description
- `penalty` + Options to send to the reporter. These are defined by the reporter.
-
- -
+
Type
- `number` + [`Serializable`](#serializable)
-
-
Description
-
- The amount of penalty to apply. -
-
+ + + --- -#### `regexp` {#patternadjustment-regexp} +## ReporterSettings {#reportersettings} +
-
Name
+ +
Description
- `regexp` + 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
- `string` + [`ReporterModuleName`](#reportermodulename)
[`ReporterModuleName`](#reportermodulename)`[]`
`Unknown``[]`
-
-
Description
-
- RegExp pattern to match -
-
-## PatternId -**Not Handled:** string -## PatternRef -**Not Handled:** undefined +--- -## PredefinedPatterns +## Serializable {#serializable} + + +
+ +
Type
+
+ `number`
`string`
`boolean`
`null`
`object` +
+
-**Not Handled:** string -## RegExpPatternDefinition -| Field | Type | Description | -| --------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------ | -| [description](#regexppatterndefinition-description) | `string` | Description of the pattern. | -| [name](#regexppatterndefinition-name) | `PatternId` | Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. | -| [pattern](#regexppatterndefinition-pattern) | `Pattern`
`Pattern[]` | RegExp pattern or array of RegExp patterns. | -### RegExpPatternDefinition Fields --- -#### `description` {#regexppatterndefinition-description} +## SimpleGlob {#simpleglob} +
-
Name
+ +
Description
- `description` + Simple Glob string, the root will be globRoot.
-
- -
+
Type
`string`
-
-
Description
-
- Description of the pattern. -
-
+ + + --- -#### `name` {#regexppatterndefinition-name} +## SuggestionCostMapDef {#suggestioncostmapdef} +
-
Name
+ +
Description
- `name` + 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
- `PatternId` + [`CostMapDefReplace`](#costmapdefreplace)
[`CostMapDefInsDel`](#costmapdefinsdel)
[`CostMapDefSwap`](#costmapdefswap)
-
-
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. -
-
+ + + --- -#### `pattern` {#regexppatterndefinition-pattern} +## SuggestionCostsDefs {#suggestioncostsdefs} -
-
Name
-
- `pattern` -
-
+
Type
- `Pattern`
`Pattern[]` -
-
- -
-
Description
-
- RegExp pattern or array of RegExp patterns. + [`SuggestionCostMapDef`](#suggestioncostmapdef)`[]`
-## RegExpPatternList - -**Not Handled:** array -## ReplaceEntry -**Not Handled:** array -## ReplaceMap -**Not Handled:** array +--- -## ReporterModuleName +## Version {#version} -**Not Handled:** string -## ReporterOptions +
+ +
Type
+
+ [`VersionLatest`](#versionlatest)
[`VersionLegacy`](#versionlegacy) +
+
-**Not Handled:** undefined -## ReporterSettings -**Not Handled:** undefined -## Serializable -**Not Handled:** undefined +--- -## SimpleGlob +## VersionLatest {#versionlatest} -**Not Handled:** string -## SuggestionCostMapDef +
+ +
Description
+
+ Configuration File Version. +
+ +
Type
+
+ `string` +
+
-**Not Handled:** undefined -## SuggestionCostsDefs -**Not Handled:** array -## Version -**Not Handled:** undefined +--- -## VersionLatest +## VersionLegacy {#versionlegacy} -**Not Handled:** string -## VersionLegacy +
+ +
Description
+
+ Legacy Configuration File Versions. +
+ +
Type
+
+ `string` +
+
-**Not Handled:** string