fix: Fix GutterTooltip and GutterKeyboardEvent declarations #5715
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
|
One of the public type files has been updated, plase make sure there are no backwards incompatible changes done in the PR. |
jperals
changed the title
typeof from type imports in declarations
akoreman
approved these changes
Jan 9, 2025
timogasda
reviewed
Jan 9, 2025
| type Config = typeof import("./src/config"); | ||
| type GutterTooltip = typeof import( "./src/mouse/default_gutter_handler").GutterTooltip; | ||
| type GutterKeyboardEvent = typeof import( "./src/keyboard/gutter_handler").GutterKeyboardEvent; | ||
| type GutterTooltip = import( "./src/mouse/default_gutter_handler").GutterTooltip; |
There was a problem hiding this comment.
Might be worth leaving a comment here on why this is important
Contributor
Author
There was a problem hiding this comment.
Note that line 29 is the one using typeof. Not using it is the default/straightforward case. If a comment is needed, it should be rather for why it is needed on that line —but I don't have the context to tell (maybe it isn't :))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue #, if available: n/a
Description of changes:
The usage of
typeofprevents consumers from reading the type properties. In our case, this triggers TypeScript errors here like:Applying the change in this PR to the local ace-builds package fixes this error and the type properties are available to TS as expected.
I assume the
typeofwas copied over unintentionally from the previous line.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Pull Request Checklist:
ace.d.ts) and its references: