Skip to content

Add packageOptions config value for packages mode #2523

Closed
@Gerrit0

Description

@Gerrit0

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributorshelp wantedContributions are especially encouraged

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions