Variable: cssDocSchema

const cssDocSchema: object;

Defined in: packages/config/src/schema.ts:10

The JSON Schema (draft-07) describing a valid cssdoc.json.

Type Declaration

$id

readonly $id: "https://cssdoc.dev/cssdoc.schema.json" = "https://cssdoc.dev/cssdoc.schema.json";

$schema

readonly $schema: "http://json-schema.org/draft-07/schema#" = "http://json-schema.org/draft-07/schema#";

additionalProperties

readonly additionalProperties: false = false;

description

readonly description: "Configuration for @cssdoc/core: custom tags and inherited configs." = "Configuration for @cssdoc/core: custom tags and inherited configs.";

properties

readonly properties: object;

properties.$schema

readonly $schema: object;

properties.$schema.type

readonly type: "string" = "string";

properties.extends

readonly extends: object;

properties.extends.description

readonly description: "Paths to other cssdoc.json files (or packages) to inherit tag definitions from." = "Paths to other cssdoc.json files (or packages) to inherit tag definitions from.";

properties.extends.items

readonly items: object;

properties.extends.items.type

readonly type: "string" = "string";

properties.extends.type

readonly type: "array" = "array";

properties.noStandardTags

readonly noStandardTags: object;

properties.noStandardTags.description

readonly description: "Disable every built-in standard tag; only tagDefinitions remain supported." = "Disable every built-in standard tag; only tagDefinitions remain supported.";

properties.noStandardTags.type

readonly type: "boolean" = "boolean";

properties.supportForTags

readonly supportForTags: object;

properties.supportForTags.additionalProperties

readonly additionalProperties: object;

properties.supportForTags.additionalProperties.type

readonly type: "boolean" = "boolean";

properties.supportForTags.description

readonly description: "Enable or disable specific tags by name." = "Enable or disable specific tags by name.";

properties.supportForTags.type

readonly type: "object" = "object";

properties.tagDefinitions

readonly tagDefinitions: object;

properties.tagDefinitions.description

readonly description: "Custom tags to register." = "Custom tags to register.";

properties.tagDefinitions.items

readonly items: object;

properties.tagDefinitions.items.additionalProperties

readonly additionalProperties: false = false;

properties.tagDefinitions.items.properties

readonly properties: object;

properties.tagDefinitions.items.properties.aliasFor

readonly aliasFor: object;

properties.tagDefinitions.items.properties.aliasFor.type

readonly type: "string" = "string";

properties.tagDefinitions.items.properties.allowMultiple

readonly allowMultiple: object;

properties.tagDefinitions.items.properties.allowMultiple.type

readonly type: "boolean" = "boolean";

properties.tagDefinitions.items.properties.recordKind

readonly recordKind: object;

properties.tagDefinitions.items.properties.recordKind.enum

readonly enum: readonly ["component", "utility", "rule", "declaration"];

properties.tagDefinitions.items.properties.syntaxKind

readonly syntaxKind: object;

properties.tagDefinitions.items.properties.syntaxKind.enum

readonly enum: readonly ["record", "block", "modifier", "inline"];

properties.tagDefinitions.items.properties.tagName

readonly tagName: object;

properties.tagDefinitions.items.properties.tagName.pattern

readonly pattern: "^@?[a-zA-Z][a-zA-Z0-9-]*$" = "^@?[a-zA-Z][a-zA-Z0-9-]*$";

properties.tagDefinitions.items.properties.tagName.type

readonly type: "string" = "string";

properties.tagDefinitions.items.required

readonly required: readonly ["tagName", "syntaxKind"];

properties.tagDefinitions.items.type

readonly type: "object" = "object";

properties.tagDefinitions.type

readonly type: "array" = "array";

title

readonly title: "cssdoc.json" = "cssdoc.json";

type

readonly type: "object" = "object";