Class: CssDocConfiguration

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

A parse configuration: the set of tag definitions plus which are supported. Construct one to get the full standard vocabulary, then add custom tags or disable standard ones.

Example

import { CssDocConfiguration, CssDocTagDefinition, parseCssDocs } from "@cssdoc/core";

const config = new CssDocConfiguration();
config.addTagDefinition(new CssDocTagDefinition({ tagName: "@token", syntaxKind: "block" }), true);
const model = parseCssDocs(css, { configuration: config });

Constructors

Constructor

new CssDocConfiguration(): CssDocConfiguration;

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

Returns

CssDocConfiguration

Properties

standardTagNames

readonly static standardTagNames: readonly string[];

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

The names (without @) of every standard tag.

Accessors

supportedTagDefinitions

Get Signature

get supportedTagDefinitions(): readonly CssDocTagDefinition[];

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

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:97

Every registered tag definition, in registration order.

Returns

readonly CssDocTagDefinition[]

Methods

addTagDefinition()

addTagDefinition(definition, supported?): void;

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

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:124

Register several tag definitions.

Parameters

definitions

readonly CssDocTagDefinition[]

supported?

boolean = true

Returns

void

---

isTagSupported()

isTagSupported(definition): boolean;

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

Whether a tag definition is supported.

Parameters

definition

CssDocTagDefinition

Returns

boolean

---

setNoStandardTags()

setNoStandardTags(): void;

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

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:139

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:145

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:129

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:205

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

Returns

CssDocTagDefinition[]