Allow shell option to be a file URL

Author: ehmicky

index.d.ts

@@ -256,7 +256,7 @@ export type CommonOptions<EncodingType extends EncodingOption = DefaultEncodingO
 
 	@default false
 	*/
-	readonly shell?: boolean | string;
+	readonly shell?: boolean | string | URL;
 
 	/**
 	Specify the character encoding used to decode the `stdout` and `stderr` output. If set to `'buffer'`, then `stdout` and `stderr` will be a `Uint8Array` instead of a string.

index.js

@@ -30,16 +30,16 @@ const getEnv = ({env: envOption, extendEnv, preferLocal, localDir, execPath}) =>
 	return env;
 };
 
+const normalizeFileUrl = file => file instanceof URL ? fileURLToPath(file) : file;
+
 const getFilePath = file => {
-	if (file instanceof URL) {
-		return fileURLToPath(file);
-	}
+	const fileString = normalizeFileUrl(file);
 
-	if (typeof file !== 'string') {
+	if (typeof fileString !== 'string') {
 		throw new TypeError('First argument must be a string or a file URL.');
 	}
 
-	return file;
+	return fileString;
 };
 
 const handleArguments = (file, args, options = {}) => {
@@ -63,6 +63,7 @@ const handleArguments = (file, args, options = {}) => {
 		windowsHide: true,
 		verbose: verboseDefault,
 		...options,
+		shell: normalizeFileUrl(options.shell),
 	};
 
 	options.env = getEnv(options);

index.test-d.ts

@@ -264,6 +264,7 @@ execa('unicorns', {uid: 0});
 execa('unicorns', {gid: 0});
 execa('unicorns', {shell: true});
 execa('unicorns', {shell: '/bin/sh'});
+execa('unicorns', {shell: fileUrl});
 execa('unicorns', {timeout: 1000});
 execa('unicorns', {maxBuffer: 1000});
 execa('unicorns', {killSignal: 'SIGTERM'});

package.json

@@ -65,6 +65,7 @@
 		"path-key": "^4.0.0",
 		"tempfile": "^5.0.0",
 		"tsd": "^0.29.0",
+		"which": "^4.0.0",
 		"xo": "^0.56.0"
 	},
 	"c8": {

readme.md

@@ -718,7 +718,7 @@ Sets the group identity of the process.
 
 #### shell
 
-Type: `boolean | string`\
+Type: `boolean | string | URL`\
 Default: `false`
 
 If `true`, runs `file` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows.

test/test.js

@@ -4,6 +4,7 @@ import {fileURLToPath, pathToFileURL} from 'node:url';
 import test from 'ava';
 import isRunning from 'is-running';
 import getNode from 'get-node';
+import which from 'which';
 import {execa, execaSync, execaNode, $} from '../index.js';
 import {setFixtureDir, PATH_KEY, FIXTURES_DIR_URL} from './helpers/fixtures-dir.js';
 
@@ -245,11 +246,15 @@ test('can use `options.shell: true`', async t => {
 	t.is(stdout, 'foo');
 });
 
-test('can use `options.shell: string`', async t => {
-	const shell = process.platform === 'win32' ? 'cmd.exe' : '/bin/bash';
+const testShellPath = async (t, mapPath) => {
+	const shellPath = process.platform === 'win32' ? 'cmd.exe' : 'bash';
+	const shell = mapPath(await which(shellPath));
 	const {stdout} = await execa('node test/fixtures/noop.js foo', {shell});
 	t.is(stdout, 'foo');
-});
+};
+
+test('can use `options.shell: string`', testShellPath, identity);
+test('can use `options.shell: file URL`', testShellPath, pathToFileURL);
 
 test('use extend environment with `extendEnv: true` and `shell: true`', async t => {
 	process.env.TEST = 'test';