feat: add link to "DTS from JS" doc in allowJs in reference
#2395
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- `allowJs` (and `checkJs`) are marked as `relatedTo`
`emitDeclarationOnly` in the reference, yet this relationship is never
explained in the reference itself
- as such, link out to the "DTS from JS" doc in the handbook, which
explains the relationship and how to use them together in detail
- hopefully this clarifies things for JS users who may be especially
unfamiliar with the various tsconfig options
- related to an old, closed PR of mine where I tried to remove the
`relatedTo` `emitDeclarationOnly`
- the alternative I listed there was to link to the "DTS from JS" doc,
but that was never implemented, so doing that now!
jakebailey
approved these changes
May 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
In
allowJsin the TSConfig Reference, link out to the "DTS from JS" doc in the handbook to explain the relationship toemitDeclarationOnly.Details
allowJs(andcheckJs) are marked asrelatedToemitDeclarationOnlyin the reference, yet this relationship is never explained in the reference itselftsconfigoptionsrelated to an old, closed PR of mine (fix: allowJs and checkJs shouldn't be relatedTo emitDeclarationOnly #1098) where I tried to remove the
relatedToemitDeclarationOnlyReview Notes
Let me know if you'd prefer the text/copy to be a bit different.
In particular, if in-line links are not preferred, then the link could be moved to a second sentence that says "See the handbook for more details" instead.