tsdoc
tsdoc copied to clipboard
tsdoc.json not detected in yarn workspaces project
Hi,
I'm trying to add custom tags to use alongside tsdoc via creating a tsdoc.json
and eslint-plugin-tsdoc
. However, eslint doesn't seem to recognise the tsdoc.json
file and I still get error messages like tsdoc-undefined-tag: The TSDoc tag "@description" is not defined in this configurationeslint[tsdoc/syntax](https://tsdoc.org/pages/packages/eslint-plugin-tsdoc)
.
The project I'm working using yarn workspaces. I wonder whether this is affecting the discoverability of the tsdoc.json
file. It is placed at the highest level in the project next to the tsconfig.json
as the documentation recommends.
Is there another step for getting it to work in this kind of project? Or is there something else I could be getting wrong?
Below is the tsdoc.json
I'm trying to use:
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@description",
"syntaxKind": "block"
}
],
"supportForTags": {
"@description": true
}
}