Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tsdoc.json not detected in yarn workspaces project #345

Open
debitan opened this issue Mar 20, 2023 · 0 comments
Open

tsdoc.json not detected in yarn workspaces project #345

debitan opened this issue Mar 20, 2023 · 0 comments

Comments

@debitan
Copy link

debitan commented Mar 20, 2023

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
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant