fix: infer EventEmitter extensions from API #259
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
erickzhao
approved these changes
Mar 5, 2024
| 'messagechannelmain', | ||
| ]; | ||
| return !nonEventEmitters.includes(module.name.toLowerCase()); | ||
| export const isEmitter = (doc: ParsedDocumentationResult[0]) => { |
There was a problem hiding this comment.
nit: can we make this type cleaner by giving ParsedDocumentationResult[0] a type and making type ParsedDocumentationResult = MyNewType[]? Personally find that working backward from index access types makes this harder to grok at first glance.
There was a problem hiding this comment.
I would do that, but ParsedDocumentationResult comes from @electron/docs-parser not this module. So here we are.
|
🎉 This PR is included in version 8.15.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
5 tasks
dsanders11
reviewed
May 10, 2024
Comment on lines
+66
to
+68
| if (module.name.toLowerCase() === 'session' && isStaticVersion) { | ||
| console.log({ isStaticVersion, instanceModuleForStaticVersion, extendsInfo }); | ||
| } |
There was a problem hiding this comment.
@MarshallOfSound, was this debug code that got left in accidentally? Seeing the output on e/e now.
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.
Instead of hard-coding a list of modules, we now infer if a module/class is an eventemitter with the following heuristic:
on,onceandremoveListenerit's an emitter (e.g.ipcMain)This correctly identifies several exposed interfaces as not being emitters and improves the type safety of newly added modules