Improve TypeScript suggestions #1130
Merged
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
TypeScript's autocomplete will suggest pretty much any symbol that is transitively exported in your package. This includes a lot of internal functions and objects that exist for no-op or testing purposes and should not be used by customers. Use the `@internal` JSDoc annotation and the `stripInternal` option in `tsconfig.json` to avoid internal functions from being declared in the `.d.ts` files, preventing TypeScript's autocomplete from suggesting them. Added on top of the changes in #1123, which should be merged first.
unflxw
force-pushed
the
improve-typescript-suggestions
branch
from
5a112d4
to
5cd4f91
Compare
tombruijn
approved these changes
Sep 19, 2024
There was a problem hiding this comment.
The docs for stripInternal says:
This is an internal compiler option; use at your own risk, because the compiler does not check that the result is valid.
It's probably fine for now.
It suggest using api-extractor. Is that something we want to look at?
|
@tombruijn It's probably a good idea to look into Created an issue for it: #1131 |
This comment has been minimized.
This comment has been minimized.
|
Hi @unflxw, We've found some issues with your Pull Request.
|
This is a message from the daily scheduled checks. |
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.
This is probably incomplete, as I have attempted to, in doubt, err on the side of caution and avoid removing a symbol that is potentially useful to the customer. Please point out any symbols I have missed.
Use @internal to improve suggestions
TypeScript's autocomplete will suggest pretty much any symbol that
is transitively exported in your package. This includes a lot of
internal functions and objects that exist for no-op or testing
purposes and should not be used by customers.
Use the
@internalJSDoc annotation and thestripInternaloptionin
tsconfig.jsonto avoid internal functions from being declaredin the
.d.tsfiles, preventing TypeScript's autocomplete fromsuggesting them.
Added on top of the changes in #1123, which should be merged first. See implement-heartbeat-checkins...improve-typescript-suggestions for a good diff.