Skip to main content

Interface: TraceOptions

Defined in: packages/cspell/src/options.ts:157

Extends​

Properties​

all?​

optional all?: boolean

Defined in: packages/cspell/src/options.ts:173

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

allowCompoundWords?​

optional allowCompoundWords?: boolean

Defined in: packages/cspell/src/options.ts:165

Enable the allowCompoundWords option.

color?​

optional color?: boolean

Defined in: packages/cspell/src/options.ts:333

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: packages/cspell/src/options.ts:294

Path to configuration file.

Inherited from​

BaseOptions.config

defaultConfiguration?​

optional defaultConfiguration?: boolean

Defined in: packages/cspell/src/options.ts:308

Load the default configuration

Default​

true

Inherited from​

BaseOptions.defaultConfiguration

dictionary?​

optional dictionary?: string[]

Defined in: packages/cspell/src/options.ts:182

Names of dictionaries to use.

dictionaryPath?​

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

Defined in: packages/cspell/src/options.ts:186

Configure how to display the dictionary path.

exitCode?​

optional exitCode?: boolean

Defined in: packages/cspell/src/options.ts:319

Return an exit code if there are issues found.

Default​

true

Inherited from​

BaseOptions.exitCode

flag?​

optional flag?: string[]

Defined in: packages/cspell/src/options.ts:326

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: packages/cspell/src/options.ts:169

Ignore case and accents when searching for words.

languageId?​

optional languageId?: string

Defined in: packages/cspell/src/options.ts:298

Programming Language ID.

Inherited from​

BaseOptions.languageId

locale?​

optional locale?: string

Defined in: packages/cspell/src/options.ts:302

Locale to use.

Inherited from​

BaseOptions.locale

onlyFound?​

optional onlyFound?: boolean

Defined in: packages/cspell/src/options.ts:178

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

stdin?​

optional stdin?: boolean

Defined in: packages/cspell/src/options.ts:161

Use stdin for the input.

validateDirectives?​

optional validateDirectives?: boolean

Defined in: packages/cspell/src/options.ts:313

Check In-Document CSpell directives for correctness.

Inherited from​

BaseOptions.validateDirectives