---
url: /reference/@cssdoc/config/classes/CssDocConfigFile.md
---
# Class: CssDocConfigFile

Defined in: [packages/config/src/CssDocConfigFile.ts:162](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L162)

A loaded `cssdoc.json` (plus the files it `extends`), ready to configure a parser.

## Properties

### extendsFiles

```ts
readonly extendsFiles: readonly CssDocConfigFile[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:176](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L176)

The resolved files this one `extends`, in declaration order.

***

### fileNotFound

```ts
readonly fileNotFound: boolean;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:166](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L166)

Whether the file was absent.

***

### filePath

```ts
readonly filePath: string;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:164](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L164)

The absolute path the file was loaded from (or would be, when not found).

***

### globalPrecedence

```ts
readonly globalPrecedence: "base" | "global";
```

Defined in: [packages/config/src/CssDocConfigFile.ts:210](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L210)

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?

```ts
readonly optional inlineComments?: InlineCommentMode;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:180](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L180)

How inline `/* … */` comments combine with tag prose, if declared by this file.

***

### messages

```ts
readonly messages: readonly string[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:168](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L168)

Parse/validation/resolution messages collected while loading (this file only).

***

### modifierConvention?

```ts
readonly optional modifierConvention?: ModifierConventionInput;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:178](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L178)

The modifier convention declared by this file, if any.

***

### naming

```ts
readonly naming: Readonly<NamingOverride>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:199](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L199)

The name-case conventions, merged across the `extends` chain (this file wins). Pass to
`resolveNaming` in `@cssdoc/providers`.

***

### noStandardTags

```ts
readonly noStandardTags: boolean;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:170](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L170)

Whether the file disables the standard tags.

***

### providers

```ts
readonly providers: readonly ProviderRef[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:185](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L185)

Upstream cssdoc providers this file consumes (this file's own — NOT inherited via `extends`, which
carries configuration, not components). Resolve with [resolveProviders](../functions/resolveProviders.md).

***

### render

```ts
readonly render: Readonly<RenderConfig>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:216](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L216)

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

```ts
readonly ruleOptions: Readonly<RuleOptionsConfig>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:194](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L194)

Rule behavior policy options, merged across `extends` (this file wins).

***

### ruleOverrides

```ts
readonly ruleOverrides: readonly ResolvedRuleOverrideBlock[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:192](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L192)

Per-glob rule overrides, merged across `extends` before this file's overrides.

***

### ruleSeverities

```ts
readonly ruleSeverities: Readonly<Record<string, RuleSeverityOverride>>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:190](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L190)

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

```ts
readonly structureIgnore: readonly string[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:204](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L204)

Class names exempt from the `structure-unknown-selector` rule, merged (union) across the `extends`
chain. Pass to `lintModel` in `@cssdoc/providers`.

***

### supportForTags

```ts
readonly supportForTags: ReadonlyMap<string, boolean>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:174](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L174)

Per-tag support overrides declared by this file.

***

### tagDefinitions

```ts
readonly tagDefinitions: readonly CssDocTagDefinition[];
```

Defined in: [packages/config/src/CssDocConfigFile.ts:172](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L172)

The custom tag definitions declared by this file.

## Accessors

### hasErrors

#### Get Signature

```ts
get hasErrors(): boolean;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:262](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L262)

Whether this file — or any file it extends — reported an error.

##### Returns

`boolean`

## Methods

### configureParser()

```ts
configureParser(configuration): void;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:282](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L282)

Apply this file (and its `extends` chain) onto a [CssDocConfiguration](../../core/classes/CssDocConfiguration.md). Extended files are
applied first so this file's settings win.

#### Parameters

##### configuration

[`CssDocConfiguration`](../../core/classes/CssDocConfiguration.md)

The configuration to mutate.

#### Returns

`void`

***

### getErrorSummary()

```ts
getErrorSummary(): string;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:267](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L267)

A newline-joined summary of every message from this file and its `extends` chain.

#### Returns

`string`

***

### ruleSeveritiesForFile()

```ts
ruleSeveritiesForFile(filePath): Record<string, RuleSeverityOverride>;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:315](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L315)

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()

```ts
toConfiguration(): CssDocConfiguration;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:305](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L305)

Build a [CssDocConfiguration](../../core/classes/CssDocConfiguration.md) from this file. Convenience for the common case.

#### Returns

[`CssDocConfiguration`](../../core/classes/CssDocConfiguration.md)

A fresh configuration with this file applied.

***

### loadFile()

```ts
static loadFile(filePath): CssDocConfigFile;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:335](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L335)

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()

```ts
static loadForFolder(folderPath): CssDocConfigFile;
```

Defined in: [packages/config/src/CssDocConfigFile.ts:345](https://github.com/thedannywahl/cssdoc/blob/main/packages/config/src/CssDocConfigFile.ts#L345)

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`.