tsdoc.json not detected in yarn workspaces project

Open
#345 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation, tooling

Research direction

Reproduce the report in a TypeScript project using Yarn workspaces, with tsdoc.json beside tsconfig.json and eslint-plugin-tsdoc configured. Start by checking how eslint-plugin-tsdoc discovers tsdoc.json; done means the workspace configuration is found and the custom @description tag no longer produces the undefined-tag error.

Written by the indexing model from the issue text.

Description

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
  }
}
Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/tsdoc

All issues in microsoft/tsdoc

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.