Require Node.js 8

Author: sindresorhus

.travis.yml

@@ -1,3 +1,4 @@
 language: node_js
 node_js:
-  - '4'
+  - '10'
+  - '8'

index.js

@@ -3,86 +3,87 @@ const path = require('path');
 const childProcess = require('child_process');
 const isWsl = require('is-wsl');
 
-module.exports = (target, opts) => {
+module.exports = async (target, options) => {
 	if (typeof target !== 'string') {
-		return Promise.reject(new Error('Expected a `target`'));
+		throw new TypeError('Expected a `target`');
 	}
 
-	opts = Object.assign({wait: true}, opts);
+	options = {
+		wait: true,
+		...options
+	};
 
-	let cmd;
-	let appArgs = [];
-	let args = [];
-	const cpOpts = {};
+	let command;
+	let appArguments = [];
+	const cliArguments = [];
+	const childProcessOptions = {};
 
-	if (Array.isArray(opts.app)) {
-		appArgs = opts.app.slice(1);
-		opts.app = opts.app[0];
+	if (Array.isArray(options.app)) {
+		appArguments = options.app.slice(1);
+		options.app = options.app[0];
 	}
 
 	if (process.platform === 'darwin') {
-		cmd = 'open';
+		command = 'open';
 
-		if (opts.wait) {
-			args.push('-W');
+		if (options.wait) {
+			cliArguments.push('-W');
 		}
 
-		if (opts.app) {
-			args.push('-a', opts.app);
+		if (options.app) {
+			cliArguments.push('-a', options.app);
 		}
 	} else if (process.platform === 'win32' || isWsl) {
-		cmd = 'cmd' + (isWsl ? '.exe' : '');
-		args.push('/c', 'start', '""', '/b');
+		command = 'cmd' + (isWsl ? '.exe' : '');
+		cliArguments.push('/c', 'start', '""', '/b');
 		target = target.replace(/&/g, '^&');
 
-		if (opts.wait) {
-			args.push('/wait');
+		if (options.wait) {
+			cliArguments.push('/wait');
 		}
 
-		if (opts.app) {
-			args.push(opts.app);
+		if (options.app) {
+			cliArguments.push(options.app);
 		}
 
-		if (appArgs.length > 0) {
-			args = args.concat(appArgs);
+		if (appArguments.length > 0) {
+			cliArguments.push(...appArguments);
 		}
 	} else {
-		if (opts.app) {
-			cmd = opts.app;
+		if (options.app) {
+			command = options.app;
 		} else {
 			const useSystemXdgOpen = process.versions.electron || process.platform === 'android';
-			cmd = useSystemXdgOpen ? 'xdg-open' : path.join(__dirname, 'xdg-open');
+			command = useSystemXdgOpen ? 'xdg-open' : path.join(__dirname, 'xdg-open');
 		}
 
-		if (appArgs.length > 0) {
-			args = args.concat(appArgs);
+		if (appArguments.length > 0) {
+			cliArguments.push(...appArguments);
 		}
 
-		if (!opts.wait) {
-			// `xdg-open` will block the process unless
-			// stdio is ignored and it's detached from the parent
-			// even if it's unref'd
-			cpOpts.stdio = 'ignore';
-			cpOpts.detached = true;
+		if (!options.wait) {
+			// `xdg-open` will block the process unless stdio is ignored
+			// and it's detached from the parent even if it's unref'd.
+			childProcessOptions.stdio = 'ignore';
+			childProcessOptions.detached = true;
 		}
 	}
 
-	args.push(target);
+	cliArguments.push(target);
 
-	if (process.platform === 'darwin' && appArgs.length > 0) {
-		args.push('--args');
-		args = args.concat(appArgs);
+	if (process.platform === 'darwin' && appArguments.length > 0) {
+		cliArguments.push('--args', ...appArguments);
 	}
 
-	const cp = childProcess.spawn(cmd, args, cpOpts);
+	const cp = childProcess.spawn(command, cliArguments, childProcessOptions);
 
-	if (opts.wait) {
+	if (options.wait) {
 		return new Promise((resolve, reject) => {
 			cp.once('error', reject);
 
-			cp.once('close', code => {
-				if (code > 0) {
-					reject(new Error('Exited with code ' + code));
+			cp.once('close', exitCode => {
+				if (exitCode > 0) {
+					reject(new Error(`Exited with code ${exitCode}`));
 					return;
 				}
 

package.json

@@ -10,7 +10,7 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=4"
+		"node": ">=8"
 	},
 	"scripts": {
 		"test": "xo"
@@ -50,7 +50,7 @@
 		"is-wsl": "^1.1.0"
 	},
 	"devDependencies": {
-		"ava": "^0.25.0",
-		"xo": "^0.20.0"
+		"ava": "^1.3.1",
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -7,11 +7,11 @@ If need this for Electron, use [`shell.openItem()`](https://electronjs.org/docs/
 
 #### Why?
 
-- Actively maintained
-- Supports app arguments
-- Safer as it uses `spawn` instead of `exec`
-- Fixes most of the open `node-open` issues
-- Includes the latest [`xdg-open` script](http://cgit.freedesktop.org/xdg/xdg-utils/commit/?id=c55122295c2a480fa721a9614f0e2d42b2949c18) for Linux
+- Actively maintained.
+- Supports app arguments.
+- Safer as it uses `spawn` instead of `exec`.
+- Fixes most of the open `node-open` issues.
+- Includes the latest [`xdg-open` script](http://cgit.freedesktop.org/xdg/xdg-utils/commit/?id=c55122295c2a480fa721a9614f0e2d42b2949c18) for Linux.
 
 
 ## Install
@@ -24,21 +24,23 @@ $ npm install opn
 ## Usage
 
 ```js
-const opn = require('opn');
+const open = require('opn');
 
 // Opens the image in the default image viewer
-opn('unicorn.png').then(() => {
-	// image viewer closed
-});
+(async () => {
+	await open('unicorn.png');
+
+	console.log('The image viewer clsoed');
+})();
 
 // Opens the url in the default browser
-opn('http://sindresorhus.com');
+open('http://sindresorhus.com');
 
 // Specify the app to open in
-opn('http://sindresorhus.com', {app: 'firefox'});
+open('http://sindresorhus.com', {app: 'firefox'});
 
 // Specify app arguments
-opn('http://sindresorhus.com', {app: ['google chrome', '--incognito']});
+open('http://sindresorhus.com', {app: ['google chrome', '--incognito']});
 ```
 
 
@@ -73,7 +75,7 @@ On Windows you have to explicitly specify an app for it to be able to wait.
 
 ##### app
 
-Type: `string` `Array`
+Type: `string | string[]`
 
 Specify the app to open the `target` with, or an array with the app and app arguments.
 

test.js

@@ -1,6 +1,6 @@
 import test from 'ava';
 import isWsl from 'is-wsl';
-import m from '.';
+import open from '.';
 
 let chromeName;
 let firefoxName;
@@ -17,31 +17,31 @@ if (process.platform === 'darwin') {
 }
 
 // Tests only checks that opening doesn't return an error
-// it has no way make sure that it actually opened anything
+// it has no way make sure that it actually opened anything.
 
-// these have to be manually verified
+// These have to be manually verified.
 
 test('open file in default app', async () => {
-	await m('index.js');
+	await open('index.js');
 });
 
 test('not wait for the app to close if wait: false', async () => {
-	await m('http://sindresorhus.com', {wait: false});
+	await open('http://sindresorhus.com', {wait: false});
 });
 
 test('open url in default app', async () => {
-	await m('http://sindresorhus.com');
+	await open('http://sindresorhus.com');
 });
 
 test('open url in specified app', async () => {
-	await m('http://sindresorhus.com', {app: firefoxName});
+	await open('http://sindresorhus.com', {app: firefoxName});
 });
 
 test('open url in specified app with arguments', async () => {
-	await m('http://sindresorhus.com', {app: [chromeName, '--incognito']});
+	await open('http://sindresorhus.com', {app: [chromeName, '--incognito']});
 });
 
 test('return the child process when called', async t => {
-	const cp = await m('index.js');
+	const cp = await open('index.js');
 	t.true('stdout' in cp);
 });