enable IDE auto-completion for the main classes #10618
Open
+85
−20
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
k-yle
commented
Dec 20, 2024
| @@ -25,7 +25,7 @@ import { utilKeybinding, utilRebind, utilStringQs, utilCleanOsmString } from '.. | |||
|
|
|||
| export function coreContext() { | |||
| const dispatch = d3_dispatch('enter', 'exit', 'change'); | |||
| let context = utilRebind({}, dispatch, 'on'); | |||
| const context = {}; | |||
There was a problem hiding this comment.
This works because JS autocompletion is powered by TypeScript, which is smart enough to infer the type of context when defined as an empty object
utilRebind can safely be moved to the return statement because this class does not use context.on internally.
| @@ -33,7 +37,7 @@ osmEntity.node = osmNode; | |||
|
|
|||
| osmNode.prototype = Object.create(osmEntity.prototype); | |||
|
|
|||
| Object.assign(osmNode.prototype, { | |||
| const prototype = { | |||
There was a problem hiding this comment.
this is required so we can use typeof prototype in the JSDoc comment above. No runtime impact.
| * @param {...Args} args | ||
| * @returns {T & Pick<S, Args>} | ||
| */ | ||
| export function utilRebind(target, source, ...args) { |
There was a problem hiding this comment.
this had to be refactored to use spread arguments instead of the arguments keyword, because JSDoc doesn't support the arguments keyword.
there's a new unit test to confirm that this is still correctly bound.
|
Very nice! |
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.
With only a few lines of changes + some JSDoc comments, we can significantly improve the DX in this codebase by enabling autocompletion/"intellisense" in most IDEs.
Currently, common classes like
contextandosmEntityare typed asany, so your IDE can't help you. With this PR, we get autocomplete for most of the class methods:We can also reference common classes from JSDoc comments, such as
iD.ContextoriD.Graph: