RebeccaStevenstypedoc-plugin-custom-validation
\
Donate
Any donations would be much appreciated. 😄
Installation
# Install with npm
npm install -D typedoc-plugin-custom-validation
# Install with pnpm
pnpm add -D typedoc-plugin-custom-validation
# Install with yarn
yarn add -D typedoc-plugin-custom-validationUsage
All options are configured in the customValidation option.
byKind
This option is for specifying requirements for each kind of node.
Example: Require all functions to have a summary and have an @example tag.
{
"plugin": ["typedoc-plugin-custom-validation"],
"customValidation": {
"byKind": [
{
"kinds": "Function",
"summary": true,
"tags": ["example"]
}
]
}
}My Tags Don't Exists?
Due to the way typedoc works, some tags may be move to other nodes than the one they were defined on.
For example, @param tags are removed from the Function node they are defined on and its content is put onto the
corresponding Parameter node. You can require parameters to be documented with:
{
"plugin": ["typedoc-plugin-custom-validation"],
"customValidation": {
"byKind": [
{
"kinds": "Parameter",
"summary": true
}
]
}
}