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

Add packageOptions config value for packages mode #2523

Open
Gerrit0 opened this issue Mar 13, 2024 · 2 comments
Open

Add packageOptions config value for packages mode #2523

Gerrit0 opened this issue Mar 13, 2024 · 2 comments
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Milestone

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 13, 2024

Search Terms

Configuration duplication, packages mode

Problem

Currently, to set up TypeDoc with "packages" mode, you have to set up a config file for each package. In my experience, these generally look something like the following... in every single package folder.

{
    "extends": ["../../typedoc.base.json"],
    "entryPoints": ["src/index.ts"]
}

Suggested Solution

Support a packageOptions section when reading an options file. This value should be an object which recursively references TypeDoc's base configuration schema so that monorepos containing many packages whose TypeDoc configuration is currently forced to be duplicated in each directory can instead be present only in the root config, then applied to each package's options object before reading any options for that directory.

@Gerrit0 Gerrit0 added enhancement Improved functionality help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Mar 13, 2024
@nicfv
Copy link

nicfv commented Apr 27, 2024

I notice that tsconfig also needs to be present in every package for the rootdir/outdir/include paths. Do you know if there's currently a way around this?

@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Apr 27, 2024

That's a limitation of TypeScript so far as I know...

@Gerrit0 Gerrit0 added this to the v0.26.0 milestone May 5, 2024
Gerrit0 added a commit that referenced this issue May 5, 2024
@Gerrit0 Gerrit0 mentioned this issue May 5, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants