Skip to main content

Interface: BaseOptions

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

Extended by​

Properties​

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.

config?​

optional config?: string

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

Path to configuration file.

defaultConfiguration?​

optional defaultConfiguration?: boolean

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

Load the default configuration

Default​

true

exitCode?​

optional exitCode?: boolean

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

Return an exit code if there are issues found.

Default​

true

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

languageId?​

optional languageId?: string

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

Programming Language ID.

locale?​

optional locale?: string

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

Locale to use.

validateDirectives?​

optional validateDirectives?: boolean

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

Check In-Document CSpell directives for correctness.