Skip to content

Interface: LintOptions ​

Defined in: packages/lint-core/src/index.ts:115

Options for lintCssDocs.

Properties ​

configuration? ​

ts
optional configuration?: CssDocConfiguration;

Defined in: packages/lint-core/src/index.ts:117

The tag configuration to parse with (custom tags, etc.).


modifierConvention? ​

ts
optional modifierConvention?: ModifierConventionInput;

Defined in: packages/lint-core/src/index.ts:119

The modifier convention (BEM by default; rscss, bare, or a custom object).


naming? ​

ts
optional naming?: NamingRules;

Defined in: packages/lint-core/src/index.ts:126

Name-case conventions to enforce (component/part); drives the *-name-case rules.


parse? ​

ts
optional parse?: CssParse;

Defined in: packages/lint-core/src/index.ts:136

The PostCSS parser (inject a dialect parser for .scss/.less; default postcss.parse).


providerEntries? ​

ts
optional providerEntries?: readonly CssDocEntry[];

Defined in: packages/lint-core/src/index.ts:134

Components from upstream providers this scope consumes — added to the sibling set so a consumer stylesheet can compose them without a false structure-unknown-selector. Resolve via resolveProviders in @cssdoc/config.


rules? ​

ts
optional rules?: Partial<Record<RuleName, boolean | RuleSeverity>>;

Defined in: packages/lint-core/src/index.ts:124

Per-rule severity (off/warn/error). A boolean is accepted for back-compat (false → off, true → the rule's default). All rules default to warn.


structureIgnore? ​

ts
optional structureIgnore?: readonly string[];

Defined in: packages/lint-core/src/index.ts:128

Class names exempt from the structure-unknown-selector rule (literal names or * globs).

Released under the MIT License