.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - 14
+          - 12
+          - 10
+          - 8
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test

index.d.ts

@@ -33,15 +33,20 @@ declare namespace open {
 		readonly app?: string | readonly string[];
 
 		/**
-		Uses `encodeURI` to encode the `target` before executing it.
+		__deprecated__
 
-		The use with targets that are not URLs is not recommended.
+		This option will be removed in the next major release.
+		*/
+		readonly url?: boolean;
 
-		Especially useful when dealing with the [double-quotes on Windows](https://github.com/sindresorhus/open#double-quotes-on-windows) caveat.
+		/**
+		Allow the opened app to exit with nonzero exit code when the `wait` option is `true`.
+		
+		We do not recommend setting this option. The convention for success is exit code zero.
 
 		@default false
 		*/
-		readonly url?: boolean;
+		readonly allowNonzeroExitCode?: boolean;
 	}
 }
 

index.js

@@ -7,17 +7,55 @@ const isWsl = require('is-wsl');
 const isDocker = require('is-docker');
 
 const pAccess = promisify(fs.access);
-const pExecFile = promisify(childProcess.execFile);
+const pReadFile = promisify(fs.readFile);
 
 // Path to included `xdg-open`.
 const localXdgOpenPath = path.join(__dirname, 'xdg-open');
 
-// Convert a path from WSL format to Windows format:
-// `/mnt/c/Program Files/Example/MyApp.exe` → `C:\Program Files\Example\MyApp.exe`
-const wslToWindowsPath = async path => {
-	const {stdout} = await pExecFile('wslpath', ['-w', path]);
-	return stdout.trim();
-};
+/**
+Get the mount point for fixed drives in WSL.
+
+@inner
+@returns {string} The mount point.
+*/
+const getWslDrivesMountPoint = (() => {
+	// Default value for "root" param
+	// according to https://docs.microsoft.com/en-us/windows/wsl/wsl-config
+	const defaultMountPoint = '/mnt/';
+
+	let mountPoint;
+
+	return async function () {
+		if (mountPoint) {
+			// Return memoized mount point value
+			return mountPoint;
+		}
+
+		const configFilePath = '/etc/wsl.conf';
+
+		let isConfigFileExists = false;
+		try {
+			await pAccess(configFilePath, fs.constants.F_OK);
+			isConfigFileExists = true;
+		} catch (_) {}
+
+		if (!isConfigFileExists) {
+			return defaultMountPoint;
+		}
+
+		const configContent = await pReadFile(configFilePath, {encoding: 'utf8'});
+		const configMountPoint = /root\s*=\s*(.*)/g.exec(configContent);
+
+		if (!configMountPoint) {
+			return defaultMountPoint;
+		}
+
+		mountPoint = configMountPoint[1].trim();
+		mountPoint = mountPoint.endsWith('/') ? mountPoint : mountPoint + '/';
+
+		return mountPoint;
+	};
+})();
 
 module.exports = async (target, options) => {
 	if (typeof target !== 'string') {
@@ -27,29 +65,19 @@ module.exports = async (target, options) => {
 	options = {
 		wait: false,
 		background: false,
-		url: false,
+		allowNonzeroExitCode: false,
 		...options
 	};
 
 	let command;
+	let {app} = options;
 	let appArguments = [];
 	const cliArguments = [];
 	const childProcessOptions = {};
 
-	if (Array.isArray(options.app)) {
-		appArguments = options.app.slice(1);
-		options.app = options.app[0];
-	}
-
-	// Encodes the target as if it were an URL. Especially useful to get
-	// double-quotes through the “double-quotes on Windows caveat”, but it
-	// can be used on any platform.
-	if (options.url) {
-		target = encodeURI(target);
-
-		if (isWsl) {
-			target = target.replace(/&/g, '^&');
-		}
+	if (Array.isArray(app)) {
+		appArguments = app.slice(1);
+		app = app[0];
 	}
 
 	if (process.platform === 'darwin') {
@@ -63,49 +91,53 @@ module.exports = async (target, options) => {
 			cliArguments.push('--background');
 		}
 
-		if (options.app) {
-			cliArguments.push('-a', options.app);
+		if (app) {
+			cliArguments.push('-a', app);
 		}
 	} else if (process.platform === 'win32' || (isWsl && !isDocker())) {
-		command = 'cmd' + (isWsl ? '.exe' : '');
-		cliArguments.push('/s', '/c', 'start', '""', '/b');
+		const mountPoint = await getWslDrivesMountPoint();
+
+		command = isWsl ?
+			`${mountPoint}c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe` :
+			`${process.env.SYSTEMROOT}\\System32\\WindowsPowerShell\\v1.0\\powershell`;
+
+		cliArguments.push(
+			'-NoProfile',
+			'-NonInteractive',
+			'–ExecutionPolicy',
+			'Bypass',
+			'-EncodedCommand'
+		);
 
 		if (!isWsl) {
-			// Always quoting target allows for URLs/paths to have spaces and unmarked characters, as `cmd.exe` will
-			// interpret them as plain text to be forwarded as one unique argument. Enabling `windowsVerbatimArguments`
-			// disables Node.js's default quotes and escapes handling (https://git.io/fjdem).
-			// References:
-			// - Issues #17, #44, #55, #77, #101, #115
-			// - Pull requests: #74, #98
-			//
-			// As a result, all double-quotes are stripped from the `target` and do not get to your desired destination.
-			target = `"${target}"`;
 			childProcessOptions.windowsVerbatimArguments = true;
-
-			if (options.app) {
-				options.app = `"${options.app}"`;
-			}
 		}
 
+		const encodedArguments = ['Start'];
+
 		if (options.wait) {
-			cliArguments.push('/wait');
+			encodedArguments.push('-Wait');
 		}
 
-		if (options.app) {
-			if (isWsl && options.app.startsWith('/mnt/')) {
-				const windowsPath = await wslToWindowsPath(options.app);
-				options.app = windowsPath;
-			}
-
-			cliArguments.push(options.app);
+		if (app) {
+			// Double quote with double quotes to ensure the inner quotes are passed through.
+			// Inner quotes are delimited for PowerShell interpretation with backticks.
+			encodedArguments.push(`"\`"${app}\`""`, '-ArgumentList');
+			appArguments.unshift(target);
+		} else {
+			encodedArguments.push(`"${target}"`);
 		}
 
 		if (appArguments.length > 0) {
-			cliArguments.push(...appArguments);
+			appArguments = appArguments.map(arg => `"\`"${arg}\`""`);
+			encodedArguments.push(appArguments.join(','));
 		}
+
+		// Using Base64-encoded command, accepted by PowerShell, to allow special characters.
+		target = Buffer.from(encodedArguments.join(' '), 'utf16le').toString('base64');
 	} else {
-		if (options.app) {
-			command = options.app;
+		if (app) {
+			command = app;
 		} else {
 			// When bundled by Webpack, there's no actual package file path and no local `xdg-open`.
 			const isBundled = !__dirname || __dirname === '/';
@@ -147,7 +179,7 @@ module.exports = async (target, options) => {
 			subprocess.once('error', reject);
 
 			subprocess.once('close', exitCode => {
-				if (exitCode > 0) {
+				if (options.allowNonzeroExitCode && exitCode > 0) {
 					reject(new Error(`Exited with code ${exitCode}`));
 					return;
 				}

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 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:
 

package.json

@@ -1,14 +1,14 @@
 {
 	"name": "open",
-	"version": "7.0.3",
+	"version": "7.4.2",
 	"description": "Open stuff like URLs, files, executables. Cross-platform.",
 	"license": "MIT",
 	"repository": "sindresorhus/open",
 	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
 		"node": ">=8"

readme.md

@@ -4,7 +4,7 @@
 
 This is meant to be used in command-line tools and scripts, not in the browser.
 
-If need this for Electron, use [`shell.openItem()`](https://electronjs.org/docs/api/shell#shellopenitemfullpath) instead.
+If you need this for Electron, use [`shell.openPath()`](https://www.electronjs.org/docs/api/shell#shellopenpathpath) instead.
 
 Note: The original [`open` package](https://github.com/pwnall/node-open) was previously deprecated in favor of this package, and we got the name, so this package is now named `open` instead of `opn`. If you're upgrading from the original `open` package (`open@0.0.5` or lower), keep in mind that the API is different.
 
@@ -14,8 +14,8 @@ Note: The original [`open` package](https://github.com/pwnall/node-open) was pre
 - Supports app arguments.
 - Safer as it uses `spawn` instead of `exec`.
 - Fixes most of the open original `node-open` issues.
-- Includes the latest [`xdg-open` script](http://cgit.freedesktop.org/xdg/xdg-utils/commit/?id=c55122295c2a480fa721a9614f0e2d42b2949c18) for Linux.
-- Supports WSL paths to Windows apps under `/mnt/*`.
+- Includes the latest [`xdg-open` script](https://cgit.freedesktop.org/xdg/xdg-utils/commit/?id=c55122295c2a480fa721a9614f0e2d42b2949c18) for Linux.
+- Supports WSL paths to Windows apps.
 
 ## Install
 
@@ -97,11 +97,20 @@ You may also pass in the app's full path. For example on WSL, this can be `/mnt/
 Type: `boolean`\
 Default: `false`
 
-Uses `encodeURI` to encode the target before executing it.<br>
+Uses `URL` to encode the target before executing it.<br>
 We do not recommend using it on targets that are not URLs.
 
 Especially useful when dealing with the [double-quotes on Windows](#double-quotes-on-windows) caveat.
 
+##### allowNonzeroExitCode
+
+Type: `boolean`\
+Default: `false`
+
+Allow the opened app to exit with nonzero exit code when the `wait` option is `true`.
+
+We do not recommend setting this option. The convention for success is exit code zero.
+
 ## Caveats
 
 ### Double-quotes on Windows

test.js

@@ -78,6 +78,14 @@ test('open URL with query strings, spaces, pipes and a fragment', async () => {
 	await open('https://sindresorhus.com/?abc=123&def=456&ghi=w|i|t|h spaces#projects');
 });
 
+test('open URL with query strings and URL reserved characters', async () => {
+	await open('https://httpbin.org/get?amp=%26&colon=%3A&comma=%2C&commat=%40&dollar=%24&equals=%3D&plus=%2B&quest=%3F&semi=%3B&sol=%2F');
+});
+
+test('open URL with query strings and URL reserved characters with `url` option', async () => {
+	await open('https://httpbin.org/get?amp=%26&colon=%3A&comma=%2C&commat=%40&dollar=%24&equals=%3D&plus=%2B&quest=%3F&semi=%3B&sol=%2F', {url: true});
+});
+
 if (isWsl) {
 	test('open URL in specified Windows app given a WSL path to the app', async () => {
 		await open('https://sindresorhus.com', {app: firefoxWslName});