Skip to main content

Interface: BaseOptions

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

Extended by​

Properties​

color?​

optional color: boolean

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

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

config?​

optional config: string

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

Path to configuration file.

defaultConfiguration?​

optional defaultConfiguration: boolean

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

Load the default configuration

Default​

true

exitCode?​

optional exitCode: boolean

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

Return an exit code if there are issues found.

Default​

true

flag?​

optional flag: string[]

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

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

languageId?​

optional languageId: string

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

Programming Language ID.

locale?​

optional locale: string

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

Locale to use.

validateDirectives?​

optional validateDirectives: boolean

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

Check In-Document CSpell directives for correctness.