Class: CssDocConfiguration

Defined in: packages/core/src/configuration.ts:106

Constructors

Constructor

new CssDocConfiguration(): CssDocConfiguration;

Defined in: packages/core/src/configuration.ts:113

Returns

CssDocConfiguration

Properties

standardTagNames

readonly static standardTagNames: readonly string[] = CSSDOC_TAG_NAMES;

Defined in: packages/core/src/configuration.ts:199

The names (without @) of every standard tag — the canonical vocabulary from @cssdoc/spec.

Accessors

inlineComments

Get Signature

get inlineComments(): InlineCommentMode;

Defined in: packages/core/src/configuration.ts:128

How inline /* … */ comments combine with tag prose (defaults to append).

Returns

InlineCommentMode

---

modifierConvention

Get Signature

get modifierConvention(): ModifierConvention;

Defined in: packages/core/src/configuration.ts:118

The resolved modifier convention this configuration parses with (defaults to BEM).

Returns

ModifierConvention

---

supportedTagDefinitions

Get Signature

get supportedTagDefinitions(): readonly CssDocTagDefinition[];

Defined in: packages/core/src/configuration.ts:143

Only the tag definitions that are currently supported.

Returns

readonly CssDocTagDefinition[]

---

tagDefinitions

Get Signature

get tagDefinitions(): readonly CssDocTagDefinition[];

Defined in: packages/core/src/configuration.ts:138

Every registered tag definition, in registration order.

Returns

readonly CssDocTagDefinition[]

Methods

addTagDefinition()

addTagDefinition(definition, supported?): void;

Defined in: packages/core/src/configuration.ts:153

Register a tag definition. Re-registering a tag name replaces the earlier definition.

Parameters

definition

CssDocTagDefinition

The tag to add.

supported?

boolean = true

Whether it is supported (defaults to true).

Returns

void

---

addTagDefinitions()

addTagDefinitions(definitions, supported?): void;

Defined in: packages/core/src/configuration.ts:165

Register several tag definitions.

Parameters

definitions

readonly CssDocTagDefinition[]

supported?

boolean = true

Returns

void

---

isTagSupported()

isTagSupported(definition): boolean;

Defined in: packages/core/src/configuration.ts:175

Whether a tag definition is supported.

Parameters

definition

CssDocTagDefinition

Returns

boolean

---

setInlineComments()

setInlineComments(mode): void;

Defined in: packages/core/src/configuration.ts:133

Set the inline-comment combine mode.

Parameters

mode

InlineCommentMode

Returns

void

---

setModifierConvention()

setModifierConvention(input): void;

Defined in: packages/core/src/configuration.ts:123

Set the modifier convention from a preset name or a custom ModifierConvention.

Parameters

input

ModifierConventionInput

Returns

void

---

setNoStandardTags()

setNoStandardTags(): void;

Defined in: packages/core/src/configuration.ts:191

Disable support for every standard tag (custom tags added later remain supported).

Returns

void

---

setSupportForTag()

setSupportForTag(definition, supported): void;

Defined in: packages/core/src/configuration.ts:180

Enable or disable support for a tag.

Parameters

definition

CssDocTagDefinition

supported

boolean

Returns

void

---

setSupportForTags()

setSupportForTags(definitions, supported): void;

Defined in: packages/core/src/configuration.ts:186

Enable or disable support for several tags.

Parameters

definitions

readonly CssDocTagDefinition[]

supported

boolean

Returns

void

---

tryGetTagDefinition()

tryGetTagDefinition(tagName): CssDocTagDefinition | undefined;

Defined in: packages/core/src/configuration.ts:170

Look up a tag definition by name (with or without a leading @).

Parameters

tagName

string

Returns

CssDocTagDefinition | undefined

---

standardTags()

static standardTags(): CssDocTagDefinition[];

Defined in: packages/core/src/configuration.ts:202

A fresh set of the standard tag definitions (new instances on each call), built from the spec.

Returns

CssDocTagDefinition[]