-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Require Node.js 18 and Electron 30 and move to ESM
- Loading branch information
1 parent
a302ae5
commit 37d7c9b
Showing
11 changed files
with
161 additions
and
154 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
const {logError} = require('.'); | ||
import {logError} from './index.js'; | ||
|
||
window.logError = logError; | ||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,33 @@ | ||
'use strict'; | ||
const {app, BrowserWindow} = require('electron'); | ||
const path = require('path'); | ||
const {openNewGitHubIssue, debugInfo} = require('electron-util'); | ||
const unhandled = require('.'); | ||
import {app, BrowserWindow} from 'electron'; | ||
import path from 'node:path'; | ||
import {openNewGitHubIssue} from 'electron-util'; | ||
import {debugInfo} from 'electron-util/main'; | ||
import unhandled from './index.js'; | ||
|
||
unhandled({ | ||
showDialog: true, | ||
reportButton: error => { | ||
reportButton(error) { | ||
openNewGitHubIssue({ | ||
user: 'sindresorhus', | ||
repo: 'electron-unhandled', | ||
body: `\`\`\`\n${error.stack}\n\`\`\`\n\n---\n\n${debugInfo()}` | ||
body: `\`\`\`\n${error.stack}\n\`\`\`\n\n---\n\n${debugInfo()}`, | ||
}); | ||
} | ||
}, | ||
}); | ||
|
||
let mainWindow; | ||
|
||
// eslint-disable-next-line unicorn/prefer-top-level-await | ||
(async () => { | ||
await app.whenReady(); | ||
|
||
mainWindow = new BrowserWindow({ | ||
webPreferences: { | ||
preload: path.join(__dirname, 'example-preload.js') | ||
} | ||
preload: path.join(import.meta.dirname, 'example-preload.mjs'), | ||
}, | ||
}); | ||
|
||
mainWindow.openDevTools(); | ||
|
||
await mainWindow.loadURL('https://google.com'); | ||
})(); |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,15 @@ | ||
'use strict'; | ||
const assert = require('assert'); | ||
const electron = require('electron'); | ||
const unhandled = require('.'); | ||
import assert from 'node:assert'; | ||
import {app} from 'electron'; | ||
import unhandled from './index.js'; | ||
|
||
const fixture = new Error('foo'); | ||
|
||
unhandled({ | ||
showDialog: false, | ||
logger: error => { | ||
logger(error) { | ||
assert.strictEqual(error.message, fixture.message); | ||
electron.app.quit(); | ||
} | ||
app.quit(); | ||
}, | ||
}); | ||
|
||
Promise.reject(fixture); |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,79 @@ | ||
declare namespace unhandled { | ||
/** | ||
__Note:__ Options can only be specified in the `main` process. | ||
*/ | ||
export type UnhandledOptions = { | ||
/** | ||
__Note:__ Options can only be specified in the `main` process. | ||
Custom logger that receives the error. | ||
Can be useful if you for example integrate with Sentry. | ||
@default console.error | ||
*/ | ||
interface UnhandledOptions { | ||
/** | ||
Custom logger that receives the error. | ||
Can be useful if you for example integrate with Sentry. | ||
@default console.error | ||
*/ | ||
readonly logger?: (error: Error) => void; | ||
|
||
/** | ||
Present an error dialog to the user. | ||
Default: [Only in production](https://github.com/sindresorhus/electron-is-dev). | ||
*/ | ||
readonly showDialog?: boolean; | ||
|
||
/** | ||
When specified, the error dialog will include a `Report…` button, which when clicked, executes the given function with the error as the first argument. | ||
@default undefined | ||
@example | ||
``` | ||
import unhandled = require('electron-unhandled'); | ||
import {openNewGitHubIssue, debugInfo} = require('electron-util'); | ||
unhandled({ | ||
reportButton: error => { | ||
openNewGitHubIssue({ | ||
user: 'sindresorhus', | ||
repo: 'electron-unhandled', | ||
body: `\`\`\`\n${error.stack}\n\`\`\`\n\n---\n\n${debugInfo()}` | ||
}); | ||
} | ||
}); | ||
// Example of how the GitHub issue will look like: https://github.com/sindresorhus/electron-unhandled/issues/new?body=%60%60%60%0AError%3A+Test%0A++++at+%2FUsers%2Fsindresorhus%2Fdev%2Foss%2Felectron-unhandled%2Fexample.js%3A27%3A21%0A%60%60%60%0A%0A---%0A%0AExample+1.1.0%0AElectron+3.0.8%0Adarwin+18.2.0%0ALocale%3A+en-US | ||
``` | ||
*/ | ||
readonly reportButton?: (error: Error) => void; | ||
} | ||
|
||
interface LogErrorOptions { | ||
/** | ||
The title of the error dialog. | ||
@default `${appName} encountered an error` | ||
*/ | ||
readonly title?: string; | ||
} | ||
} | ||
|
||
declare const unhandled: { | ||
/** | ||
Catch unhandled errors and promise rejections in your [Electron](https://electronjs.org) app. | ||
readonly logger?: (error: Error) => void; | ||
|
||
You probably want to call this both in the `main` process and any `renderer` processes to catch all possible errors. | ||
/** | ||
Present an error dialog to the user. | ||
__Note:__ At minimum, this function must be called in the `main` process. | ||
Default: [Only in production](https://github.com/sindresorhus/electron-is-dev). | ||
*/ | ||
(options?: unhandled.UnhandledOptions): void; | ||
readonly showDialog?: boolean; | ||
|
||
/** | ||
Log an error. This does the same as with caught unhandled errors. | ||
When specified, the error dialog will include a `Report…` button, which when clicked, executes the given function with the error as the first argument. | ||
@default undefined | ||
@example | ||
``` | ||
import unhandled from 'electron-unhandled'; | ||
import {openNewGitHubIssue, debugInfo} from 'electron-util'; | ||
unhandled({ | ||
reportButton: error => { | ||
openNewGitHubIssue({ | ||
user: 'sindresorhus', | ||
repo: 'electron-unhandled', | ||
body: `\`\`\`\n${error.stack}\n\`\`\`\n\n---\n\n${debugInfo()}` | ||
}); | ||
} | ||
}); | ||
// Example of how the GitHub issue will look like: https://github.com/sindresorhus/electron-unhandled/issues/new?body=%60%60%60%0AError%3A+Test%0A++++at+%2FUsers%2Fsindresorhus%2Fdev%2Foss%2Felectron-unhandled%2Fexample.js%3A27%3A21%0A%60%60%60%0A%0A---%0A%0AExample+1.1.0%0AElectron+3.0.8%0Adarwin+18.2.0%0ALocale%3A+en-US | ||
``` | ||
*/ | ||
readonly reportButton?: (error: Error) => void; | ||
}; | ||
|
||
It will use the same options specified in the `unhandled()` call or the defaults. | ||
export type LogErrorOptions = { | ||
/** | ||
The title of the error dialog. | ||
@param error - Error to log. | ||
@default `${appName} encountered an error` | ||
*/ | ||
logError(error: Error, options?: unhandled.LogErrorOptions): void; | ||
readonly title?: string; | ||
}; | ||
|
||
export = unhandled; | ||
/** | ||
Catch unhandled errors and promise rejections in your [Electron](https://electronjs.org) app. | ||
You probably want to call this both in the `main` process and any `renderer` processes to catch all possible errors. | ||
__Note:__ At minimum, this function must be called in the `main` process. | ||
*/ | ||
export default function unhandled(options?: UnhandledOptions): void; | ||
|
||
/** | ||
Log an error. This does the same as with caught unhandled errors. | ||
It will use the same options specified in the `unhandled()` call or the defaults. | ||
@param error - The error to log. | ||
@example | ||
``` | ||
import {logError} from 'electron-unhandled'; | ||
logError(new Error('🦄')); | ||
``` | ||
*/ | ||
export function logError(error: Error, options?: LogErrorOptions): void; |
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.