Class: CssDocConfigFile
Defined in: packages/config/src/CssDocConfigFile.ts:162
A loaded cssdoc.json (plus the files it extends), ready to configure a parser.
Properties
extendsFiles
readonly extendsFiles: readonly CssDocConfigFile[];Defined in: packages/config/src/CssDocConfigFile.ts:176
The resolved files this one extends, in declaration order.
fileNotFound
readonly fileNotFound: boolean;Defined in: packages/config/src/CssDocConfigFile.ts:166
Whether the file was absent.
filePath
readonly filePath: string;Defined in: packages/config/src/CssDocConfigFile.ts:164
The absolute path the file was loaded from (or would be, when not found).
globalPrecedence
readonly globalPrecedence: "base" | "global";Defined in: packages/config/src/CssDocConfigFile.ts:210
The precedence model when multiple records define the same modifier (with at least one marked @global): "base" (explicit modifiers override global; default) or "global" (global overrides). Merged across the extends chain (this file wins). Passed to @cssdoc/index for validation.
inlineComments?
readonly optional inlineComments?: InlineCommentMode;Defined in: packages/config/src/CssDocConfigFile.ts:180
How inline /* … */ comments combine with tag prose, if declared by this file.
messages
readonly messages: readonly string[];Defined in: packages/config/src/CssDocConfigFile.ts:168
Parse/validation/resolution messages collected while loading (this file only).
modifierConvention?
readonly optional modifierConvention?: ModifierConventionInput;Defined in: packages/config/src/CssDocConfigFile.ts:178
The modifier convention declared by this file, if any.
naming
readonly naming: Readonly<NamingOverride>;Defined in: packages/config/src/CssDocConfigFile.ts:199
The name-case conventions, merged across the extends chain (this file wins). Pass to resolveNaming in @cssdoc/providers.
noStandardTags
readonly noStandardTags: boolean;Defined in: packages/config/src/CssDocConfigFile.ts:170
Whether the file disables the standard tags.
providers
readonly providers: readonly ProviderRef[];Defined in: packages/config/src/CssDocConfigFile.ts:185
Upstream cssdoc providers this file consumes (this file's own — NOT inherited via extends, which carries configuration, not components). Resolve with resolveProviders.
render
readonly render: Readonly<RenderConfig>;Defined in: packages/config/src/CssDocConfigFile.ts:216
Markdown render options (sectionOrder/headingPrefix/baseHref), merged across the extends chain (this file wins). The emitter (@cssdoc/markdown/@cssdoc/typedoc) reads these as defaults; explicit emitter options still override. Not part of the parser CssDocConfiguration.
ruleOptions
readonly ruleOptions: Readonly<RuleOptionsConfig>;Defined in: packages/config/src/CssDocConfigFile.ts:194
Rule behavior policy options, merged across extends (this file wins).
ruleOverrides
readonly ruleOverrides: readonly ResolvedRuleOverrideBlock[];Defined in: packages/config/src/CssDocConfigFile.ts:192
Per-glob rule overrides, merged across extends before this file's overrides.
ruleSeverities
readonly ruleSeverities: Readonly<Record<string, RuleSeverityOverride>>;Defined in: packages/config/src/CssDocConfigFile.ts:190
The per-rule severity overrides, merged across the extends chain (this file wins). Not the resolved severities — pass these to resolveRuleSeverities in @cssdoc/providers.
structureIgnore
readonly structureIgnore: readonly string[];Defined in: packages/config/src/CssDocConfigFile.ts:204
Class names exempt from the structure-unknown-selector rule, merged (union) across the extends chain. Pass to lintModel in @cssdoc/providers.
supportForTags
readonly supportForTags: ReadonlyMap<string, boolean>;Defined in: packages/config/src/CssDocConfigFile.ts:174
Per-tag support overrides declared by this file.
tagDefinitions
readonly tagDefinitions: readonly CssDocTagDefinition[];Defined in: packages/config/src/CssDocConfigFile.ts:172
The custom tag definitions declared by this file.
Accessors
hasErrors
Get Signature
get hasErrors(): boolean;Defined in: packages/config/src/CssDocConfigFile.ts:262
Whether this file — or any file it extends — reported an error.
Returns
boolean
Methods
configureParser()
configureParser(configuration): void;Defined in: packages/config/src/CssDocConfigFile.ts:282
Apply this file (and its extends chain) onto a CssDocConfiguration. Extended files are applied first so this file's settings win.
Parameters
configuration
The configuration to mutate.
Returns
void
getErrorSummary()
getErrorSummary(): string;Defined in: packages/config/src/CssDocConfigFile.ts:267
A newline-joined summary of every message from this file and its extends chain.
Returns
string
ruleSeveritiesForFile()
ruleSeveritiesForFile(filePath): Record<string, RuleSeverityOverride>;Defined in: packages/config/src/CssDocConfigFile.ts:315
Return this config's rule severities with every matching overrides block applied for a file. Override globs are relative to the config file where the block was authored; later matches win.
Parameters
filePath
string
Returns
Record<string, RuleSeverityOverride>
toConfiguration()
toConfiguration(): CssDocConfiguration;Defined in: packages/config/src/CssDocConfigFile.ts:305
Build a CssDocConfiguration from this file. Convenience for the common case.
Returns
A fresh configuration with this file applied.
loadFile()
static loadFile(filePath): CssDocConfigFile;Defined in: packages/config/src/CssDocConfigFile.ts:335
Load a cssdoc.json from an exact path. Missing files yield a fileNotFound instance (not an error); malformed ones collect messages.
Parameters
filePath
string
The config file path (resolved to absolute).
Returns
CssDocConfigFile
The loaded config file.
loadForFolder()
static loadForFolder(folderPath): CssDocConfigFile;Defined in: packages/config/src/CssDocConfigFile.ts:345
Find and load the nearest cssdoc.json, walking upward from folderPath to the filesystem root.
Parameters
folderPath
string
The folder to start from.
Returns
CssDocConfigFile
The nearest config file, or a fileNotFound instance rooted at folderPath.