├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.js ├── license ├── package.json ├── readme.md ├── screenshot.png └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | - 14 15 | - 12 16 | steps: 17 | - uses: actions/checkout@v2 18 | - uses: actions/setup-node@v2 19 | with: 20 | node-version: ${{ matrix.node-version }} 21 | - run: npm install 22 | - run: npm test 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import {runAppleScriptAsync} from 'run-applescript'; 2 | import escapeString from 'escape-string-applescript'; 3 | 4 | const icon = '/System/Library/CoreServices/CoreTypes.bundle/Contents/Resources/AlertStopIcon.icns'; 5 | 6 | export default async function errorDialog(error, title) { 7 | error = escapeString(error.stack || error); 8 | title = title ? `with title "${escapeString(title)}"` : ''; 9 | 10 | await runAppleScriptAsync(`display dialog "${error}" ${title} with icon POSIX file "${icon}" buttons {"OK"}`); 11 | } 12 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "error-dialog", 3 | "version": "2.0.0", 4 | "description": "Display an error in a GUI dialog", 5 | "license": "MIT", 6 | "repository": "sindresorhus/error-dialog", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": ">=12" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava" 20 | }, 21 | "files": [ 22 | "index.js" 23 | ], 24 | "keywords": [ 25 | "error", 26 | "dialog", 27 | "exception", 28 | "prompt", 29 | "window", 30 | "box", 31 | "gui", 32 | "utility", 33 | "macos", 34 | "applescript", 35 | "osascript" 36 | ], 37 | "dependencies": { 38 | "escape-string-applescript": "^3.0.0", 39 | "run-applescript": "^5.0.0" 40 | }, 41 | "devDependencies": { 42 | "ava": "^3.15.0", 43 | "xo": "^0.39.1" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # error-dialog 2 | 3 | > Display an error in a GUI dialog 4 | 5 | 6 | 7 | macOS only, but pull request welcome for Linux and Windows support. 8 | 9 | ## Install 10 | 11 | ``` 12 | $ npm install error-dialog 13 | ``` 14 | 15 | ## Usage 16 | 17 | ```js 18 | import errorDialog from 'error-dialog'; 19 | 20 | const error = new Error('Expected more unicorns!'); 21 | 22 | await errorDialog(error, '🦄'); 23 | ``` 24 | 25 | ## API 26 | 27 | ### errorDialog(error, windowTitle?) 28 | 29 | Returns a `Promise`. 30 | 31 | #### error 32 | 33 | Type: `Error | string` 34 | 35 | An error or error message. 36 | 37 | #### windowTitle 38 | 39 | Type: `string` 40 | 41 | ## Related 42 | 43 | - [cocoa-dialog](https://github.com/sindresorhus/cocoa-dialog) - Display common GUI dialogs on macOS 44 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sindresorhus/error-dialog/5375f749dce97b61f493b8fd591ddf079b023bc9/screenshot.png -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import errorDialog from './index.js'; 3 | 4 | test('main', async t => { 5 | if (process.env.CI) { 6 | t.pass(); 7 | return; 8 | } 9 | 10 | await t.notThrowsAsync(errorDialog(new Error('test'))); 11 | }); 12 | 13 | --------------------------------------------------------------------------------