Skip to main content

Interface: TraceOptions

Defined in: cspell/src/options.ts:138

Extends​

Properties​

all?​

optional all: boolean

Defined in: cspell/src/options.ts:154

Show all dictionaries, not just the ones that contain the words or are enabled.

allowCompoundWords?​

optional allowCompoundWords: boolean

Defined in: cspell/src/options.ts:146

Enable the allowCompoundWords option.

color?​

optional color: boolean

Defined in: cspell/src/options.ts:314

Use color in the output. true to force color, false to turn off color. undefined to use color if the output is a TTY.

Inherited from​

BaseOptions.color

config?​

optional config: string

Defined in: cspell/src/options.ts:275

Path to configuration file.

Inherited from​

BaseOptions.config

defaultConfiguration?​

optional defaultConfiguration: boolean

Defined in: cspell/src/options.ts:289

Load the default configuration

Default​

true

Inherited from​

BaseOptions.defaultConfiguration

dictionary?​

optional dictionary: string[]

Defined in: cspell/src/options.ts:163

Names of dictionaries to use.

dictionaryPath?​

optional dictionaryPath: "hide" | "long" | "short" | "full"

Defined in: cspell/src/options.ts:167

Configure how to display the dictionary path.

exitCode?​

optional exitCode: boolean

Defined in: cspell/src/options.ts:300

Return an exit code if there are issues found.

Default​

true

Inherited from​

BaseOptions.exitCode

flag?​

optional flag: string[]

Defined in: cspell/src/options.ts:307

Execution flags. Used primarily for releasing experimental features. Flags are of the form key:value

Inherited from​

BaseOptions.flag

ignoreCase?​

optional ignoreCase: boolean

Defined in: cspell/src/options.ts:150

Ignore case and accents when searching for words.

languageId?​

optional languageId: string

Defined in: cspell/src/options.ts:279

Programming Language ID.

Inherited from​

BaseOptions.languageId

locale?​

optional locale: string

Defined in: cspell/src/options.ts:283

Locale to use.

Inherited from​

BaseOptions.locale

onlyFound?​

optional onlyFound: boolean

Defined in: cspell/src/options.ts:159

Show only dictionaries that contain the words. If all is set, this option is ignored.

stdin?​

optional stdin: boolean

Defined in: cspell/src/options.ts:142

Use stdin for the input.

validateDirectives?​

optional validateDirectives: boolean

Defined in: cspell/src/options.ts:294

Check In-Document CSpell directives for correctness.

Inherited from​

BaseOptions.validateDirectives