microsoft / microsoft/tsdoc

Make tsdoc.json visible from upper directories

Open
#304 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

I have a single project split in various pieces, each in a subdirectory of the project top directory.
Currently, to use typedoc and eslint-plugin-tsdoc, I need to copy the configuration file tsdoc.json in each subdirectory.
Is it possible to have the above mentioned tools "climb" the directory hierarchy till a tsdoc.json file is found?
Thanks!
mario

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.

Research direction

Start by examining how typedoc and eslint-plugin-tsdoc locate tsdoc.json when invoked from a subdirectory. Compare their current configuration-discovery behavior and determine whether both tools can consistently search parent directories. Done means a shared project-level tsdoc.json is found without copying it into each subdirectory, with behavior verified for both tools.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.