Generate declaration maps #977
Draft
Conversation
This file contains hidden or 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
Adjusted our use of @overlord to the new generation behavior (overloads are generated in definition order, not vice versa). Relevant changelog entries: * https://github.com/nikku/bio-dts/blob/main/CHANGELOG.md#0120 * https://github.com/nikku/bio-dts/blob/main/CHANGELOG.md#0130
Recommended practice for library authors (that ship source code with their modules, cf. microsoft/TypeScript#49003).
nikku
requested review from
a team,
Buckwich and
jarekdanielak
and removed request for
a team
jarekdanielak
approved these changes
Jun 13, 2025
Buckwich
requested changes
Jun 16, 2025
There was a problem hiding this comment.
At the moment the generated type maps have a worse quality than the heuristic Find source definition of TS server. I agree that it would be nice to ship at least something for users, but then we should make it opt-out for users that want better maps with the cost of worse performance. Alternative would be to adjust tooling to generate proper maps
bpmn-io-tasks
bot
added
in progress
|
Here are also some references:
|
|
@jarekdanielak did you try this setting?
|
|
@Buckwich yeah, actually with that setting on I'm getting better results without the new types. 🤨 |
|
This did not get consensus, I move it back to |
|
should we also mark this PR as draft? |
bpmn-io-tasks
bot
added
in progress
barmac
added
backlog
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.
Proposed Changes
Generates types with declaration maps, the recommended practice for library authors that ship source code.
Once generated, "Go to definition" (
F12in Sublime Text) will no longer jump to types, but to the actual source file:Try out
git checkout generate-declaration-mapsnpm run generate-typesChecklist
To ensure you provided everything we need to look at your PR:
@bpmn-io/srtoolCloses {LINK_TO_ISSUE}orRelated to {LINK_TO_ISSUE}Related to discussion