fix: ensure the typescript definitions only export correct value types #28712
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
MarshallOfSound
force-pushed
the
fix-exported-values
branch
from
c678f82
to
384966e
Compare
MarshallOfSound
force-pushed
the
fix-exported-values
branch
from
be65e65
to
d9ce605
Compare
nornagon
requested changes
Apr 20, 2021
|
@nornagon We have to distinguish between a module being "available" in a process and a module being "exported" in the |
3 tasks
In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes #22167
MarshallOfSound
force-pushed
the
fix-exported-values
branch
3 times, most recently
from
91a5cf9
to
dcd479a
Compare
MarshallOfSound
force-pushed
the
fix-exported-values
branch
from
dcd479a
to
f7949f3
Compare
nornagon
reviewed
Jun 14, 2021
MarshallOfSound
force-pushed
the
fix-exported-values
branch
from
f7949f3
to
fc0cfcb
Compare
nornagon
approved these changes
Jun 15, 2021
|
Release Notes Persisted
|
BlackHole1
pushed a commit
to BlackHole1/electron
that referenced
this pull request
Aug 30, 2021
electron#28712) * fix: ensure the typescript definitions only export correct value types In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes electron#22167 * chore: update typescript-defs * chore: update typescript-defs * chore: fix bad typescript in IPC test * docs: test rendering of new syntax * chore: update per feedback, use same syntax but with 'this is not exportedd' line
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.
In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want).
This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export.
Fixes #22167
This PR is currently targeting
update-ts-parseras it relies on some of those changes and this shows the actual diff.I've marked this as
semver/patchbut out of an abundance of caution this shouldn't be backportedNotes: Fixed typescript export definitions such that not-exported values are not declared in the exports interface