tsdoc.json

TSDoc configuration file

Type object
File match tsdoc.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/tsdoc-json/latest.json
Source https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Describes the TSDoc configuration for a TypeScript project

Properties

$schema string required

Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.

extends string[]

Optionally specifies one or more JSON config files that will be combined with this file. This provides a way for standard settings to be shared across multiple projects. Important: The "extends" paths are resolved using NodeJS module resolution, so a path to a local file MUST be prefixed with "./".

noStandardTags boolean

By default, the config file loader will predefine all of the standardized TSDoc tags. To disable this and start with a completely empty configuration, set "noStandardTags"=true.

tagDefinitions tsdocTagDefinition[]

Additional tags to support when parsing documentation comments with TSDoc.

supportedHtmlElements string[]

The HTML element names that are supported in this configuration. Used in conjunction with the "reportUnsupportedHtmlElements" setting.

reportUnsupportedHtmlElements boolean

Whether an error should be reported when an unsupported HTML element is encountered in a doc comment. Defaults to "true" if the "supportedHtmlElements" field is present in this file, "false" if not.

supportForTags object

A collection of key/value pairs. The key is a TSDoc tag name (e.g. "@myTag") that must be defined in this configuration. The value is a boolean indicating whether the tag is supported. The TSDoc parser may report warnings when unsupported tags are encountered. If "supportForTags" is specified for at least one tag, then the "reportUnsupportedTags" validation check is enabled by default.

Definitions

tsdocTagDefinition object

Configuration for a custom supported TSDoc tag.

tagName string required

Name of the custom tag. TSDoc tag names start with an at-sign (@) followed by ASCII letters using camelCase capitalization.

syntaxKind string required

Syntax kind of the custom tag. "inline" means that this tag can appear inside other documentation sections (example: {@link}). "block" means that this tag starts a new documentation section (example: @remarks). "modifier" means that this tag's presence indicates an aspect of the associated API item (example: @internal).

Values: "inline" "block" "modifier"
allowMultiple boolean

If true, then this tag may appear multiple times in a doc comment. By default, a tag may only appear once.