Add support for a typedocMain
field in package.json.
#1677
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This can be used to generate a tree of your source using
tsc
and pointat it to generate documentation outside your normal build process.
This takes a different tack and instead of falling back to the typings, this allows you to set a specific packageMain value that is built directly with TSC. This can act as an escape hatch for projects with weird builds that involve webpack / rollup / etc, and more complex typings setups with api-extractor to go along with the bundling.
For example, in our particular case, we use webpack 4 and api-extractor to bundle packages that are used at development time, but publicly are exposed as a single package. Therefore we bundle the TS via webpack and tsloader, and bundle the declaration files using an api-extractor rollup.
Resolves #1674.