JSON schema for cspell configuration file Json Format

$schema

allowCompoundWords - True to enable compound word checking.

caseSensitive - Words must match case rules.

description - Optional description of configuration

enabled - Is the spell checker enabled

id - Optional identifier

language - This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.

languageId - This can be '*', 'typescript', 'cpp', 'json', etc.

maxDuplicateProblems - The maximum number of times the same word can be flagged as an error in a file.

maxNumberOfProblems - The maximum number of problems to report in a file.

minWordLength - The minimum length of a word before checking it against a dictionary.

name - Optional name of configuration

numSuggestions - Number of suggestions to make

showStatus - Show status

spellCheckDelayMs - Delay in ms after a document has changed before checking it for spelling errors.

version - Configuration format version of the setting file.

dictionaries Optional list of dictionaries to use.

#	Values	Actions
{{$index+1}}.

dictionaryDefinitions Define additional available dictionaries

#	Actions
{{$index+1}}.

enabledLanguageIds languageIds for the files to spell check.

#	Values	Actions
{{$index+1}}.

flagWords list of words to always be considered incorrect.

#	Values	Actions
{{$index+1}}.

ignorePaths Glob file patterns to be ignored

#	Values	Actions
{{$index+1}}.

ignoreRegExpList ignoreRegExpList

#	Actions
{{$index+1}}.

ignoreWords list of words to be ignored

#	Values	Actions
{{$index+1}}.

includeRegExpList includeRegExpList

#	Actions
{{$index+1}}.

languageSettings Additional settings for individual languages.

#	allowCompoundWords	caseSensitive	description	enabled	id	name	Actions
{{$index+1}}.	{{row.allowCompoundWordsSelected.DisplayText}}	{{row.caseSensitiveSelected.DisplayText}}	{{row.description}}	{{row.enabledSelected.DisplayText}}	{{row.id}}	{{row.name}}

overrides Overrides to apply based upon the file path.

#	allowCompoundWords	caseSensitive	description	enabled	id	language	languageId	maxDuplicateProblems	maxNumberOfProblems	minWordLength	Actions
{{$index+1}}.	{{row.allowCompoundWordsSelected.DisplayText}}	{{row.caseSensitiveSelected.DisplayText}}	{{row.description}}	{{row.enabledSelected.DisplayText}}	{{row.id}}	{{row.language}}	{{row.languageId}}	{{row.maxDuplicateProblems}}	{{row.maxNumberOfProblems}}	{{row.minWordLength}}

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

#	description	name	Actions
{{$index+1}}.

userWords Words to add to dictionary -- should only be in the user config file.

#	Values	Actions
{{$index+1}}.

words list of words to be always considered correct

#	Values	Actions
{{$index+1}}.

allowCompoundWords - True to enable compound word checking.

caseSensitive - Words must match case rules.

description - Optional description of configuration

enabled - Is the spell checker enabled

id - Optional identifier

name - Optional name of configuration

dictionaries Optional list of dictionaries to use.

#	Values	Actions
{{$index+1}}.

dictionaryDefinitions Define additional available dictionaries

#	Actions
{{$index+1}}.

flagWords list of words to always be considered incorrect.

#	Values	Actions
{{$index+1}}.

ignoreRegExpList ignoreRegExpList

#	Actions
{{$index+1}}.

includeRegExpList includeRegExpList

#	Actions
{{$index+1}}.

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

#	description	name	Actions
{{$index+1}}.

words list of words to be always considered correct

#	Values	Actions
{{$index+1}}.

allowCompoundWords - True to enable compound word checking.

caseSensitive - Words must match case rules.

description - Optional description of configuration

enabled - Is the spell checker enabled

id - Optional identifier

language - This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.

languageId - This can be '*', 'typescript', 'cpp', 'json', etc.

maxDuplicateProblems - The maximum number of times the same word can be flagged as an error in a file.

maxNumberOfProblems - The maximum number of problems to report in a file.

minWordLength - The minimum length of a word before checking it against a dictionary.

name - Optional name of configuration

numSuggestions - Number of suggestions to make

dictionaries Optional list of dictionaries to use.

#	Values	Actions
{{$index+1}}.

dictionaryDefinitions Define additional available dictionaries

#	Actions
{{$index+1}}.

enabledLanguageIds languageIds for the files to spell check.

#	Values	Actions
{{$index+1}}.

flagWords list of words to always be considered incorrect.

#	Values	Actions
{{$index+1}}.

ignorePaths Glob file patterns to be ignored

#	Values	Actions
{{$index+1}}.

ignoreRegExpList ignoreRegExpList

#	Actions
{{$index+1}}.

ignoreWords list of words to be ignored

#	Values	Actions
{{$index+1}}.

includeRegExpList includeRegExpList

#	Actions
{{$index+1}}.

languageSettings Additional settings for individual languages.

#	allowCompoundWords	caseSensitive	description	enabled	id	name	Actions
{{$index+1}}.	{{row.allowCompoundWordsSelected.DisplayText}}	{{row.caseSensitiveSelected.DisplayText}}	{{row.description}}	{{row.enabledSelected.DisplayText}}	{{row.id}}	{{row.name}}

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

#	description	name	Actions
{{$index+1}}.

words list of words to be always considered correct

#	Values	Actions
{{$index+1}}.

ToolMatter

Your Apps in Action

Use this form to visualize JSON schema for cspell configuration file.

{{repoTitle.MainEntity}}

dictionaries Optional list of dictionaries to use.

dictionaryDefinitions Define additional available dictionaries

enabledLanguageIds languageIds for the files to spell check.

flagWords list of words to always be considered incorrect.

ignorePaths Glob file patterns to be ignored

ignoreRegExpList ignoreRegExpList

ignoreWords list of words to be ignored

includeRegExpList includeRegExpList

languageSettings Additional settings for individual languages.

overrides Overrides to apply based upon the file path.

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

userWords Words to add to dictionary -- should only be in the user config file.

words list of words to be always considered correct

{{repoTitle.MainEntity}}

dictionaries Optional list of dictionaries to use.

dictionaryDefinitions Define additional available dictionaries

flagWords list of words to always be considered incorrect.

ignoreRegExpList ignoreRegExpList

includeRegExpList includeRegExpList

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

words list of words to be always considered correct

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

dictionaries Optional list of dictionaries to use.

dictionaryDefinitions Define additional available dictionaries

enabledLanguageIds languageIds for the files to spell check.

flagWords list of words to always be considered incorrect.

ignorePaths Glob file patterns to be ignored

ignoreRegExpList ignoreRegExpList

ignoreWords list of words to be ignored

includeRegExpList includeRegExpList

languageSettings Additional settings for individual languages.

patterns Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList

words list of words to be always considered correct