Update docs for --configPlugin using typescript #4495
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 PR contains:
Are tests included?
Breaking Changes?
List any relevant issue numbers:
Description
The documentation gives examples for using
@rollup/plugin-typescript
to parse the Rollup configuration file, with a CLI code example. However, that example will fail to build with a somewhat misleading error if the Rollup config is not declared in thetsconfig.json
'sinclude
property, so a note about needing to do so has been added with this commit.For an example of the error I'm referring to, here is what happened to me:
This is pretty obvious when you know the answer, but when you first get this error after following the docs, it is a bit confusing because it seems like something is wrong with your CLI flags or the config itself due to the error giving the same output as if the
@rollup/plugin-typescript
was not setup at all.I'm happy to reword this, or move it somewhere else if anyone has suggestions.