-
Notifications
You must be signed in to change notification settings - Fork 15k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: deprecate remote #25293
chore: deprecate remote #25293
Conversation
@@ -50,6 +50,25 @@ If your crash ingestion server does not support compressed payloads, you can | |||
turn off compression by specifying `{ compress: false }` in the crash reporter | |||
options. | |||
|
|||
### Deprecated: `remote` module | |||
|
|||
The `remote` module is deprecated in Electron 12, and will be removed in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we utilize this message to further indicate that you shouldn't just replace and forget. Let's use it as another chance to educate why using remote
is bad.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The @electron/remote repository has a big warning at the top. I think that's enough.
import { browserModuleNames } from '@electron/internal/browser/api/module-names'; | ||
import { commonModuleList } from '@electron/internal/common/api/module-list'; | ||
|
||
deprecate.log('The remote module is deprecated. Use https://github.com/electron/remote instead.'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also update this doc to note that remote is deprecated:
https://www.electronjs.org/docs/api/remote
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doh! @nornagon I missed that the doc had been updated.
Release Notes Persisted
|
only breaking changes were how the remote API is called (@electron/remote) electron/electron#25293 in order for react imports to work, `contextIsolation` has to be set to `false`, since it is `true` by default now
only breaking changes were how the remote API is called (@electron/remote) electron/electron#25293 in order for react imports to work, `contextIsolation` has to be set to `false`, since it is `true` by default now
Description of Change
Ref #21408.
This adds a new deprecation warning message when
require('electron').remote
is encountered.Checklist
npm test
passesRelease Notes
Notes: Deprecated the
remote
module. It is replaced by@electron/remote
.