Merge branch 'main' into link-to-link-to-shell

Author: ericcornelissen

src/index.js

@@ -118,7 +118,8 @@ export class Shescape {
    * Take an array of values, the arguments, and escape any dangerous characters
    * in every argument.
    *
-   * Non-string inputs will be converted to strings using a `toString()` method.
+   * Non-array inputs are rejected. Non-string entries will be converted to
+   * strings using a `toString()` method.
    *
    * @param {string[]} args The arguments to escape.
    * @returns {string[]} The escaped arguments.
@@ -152,7 +153,8 @@ export class Shescape {
    * Take an array of values, the arguments, put shell-specific quotes around
    * every argument and escape any dangerous characters in every argument.
    *
-   * Non-string inputs will be converted to strings using a `toString()` method.
+   * Non-array inputs are rejected. Non-string entries will be converted to
+   * strings using a `toString()` method.
    *
    * @param {string[]} args The arguments to quote and escape.
    * @returns {string[]} The quoted and escaped arguments.

src/stateless.js

@@ -36,8 +36,8 @@ export function escape(arg, options) {
  * Take an array of values, the arguments, and escape any dangerous characters
  * in every argument.
  *
- * Non-array inputs will be converted to one-value arrays and non-string values
- * will be converted to strings using a `toString()` method.
+ * Non-array inputs are rejected. Non-string entries will be converted to
+ * strings using a `toString()` method.
  *
  * @example
  * import { spawn } from "node:child_process";
@@ -51,6 +51,7 @@ export function escape(arg, options) {
  * @param {boolean} [options.flagProtection=true] Is flag protection enabled.
  * @param {boolean | string} [options.shell=true] The shell to escape for.
  * @returns {string[]} The escaped arguments.
+ * @throws {TypeError} The arguments are not an array.
  * @throws {TypeError} One of the arguments is not stringable.
  * @throws {Error} The shell is not supported or could not be found.
  * @since 2.1.0
@@ -93,8 +94,8 @@ export function quote(arg, options) {
  * Take an array of values, the arguments, put shell-specific quotes around
  * every argument and escape any dangerous characters in every argument.
  *
- * Non-array inputs will be converted to one-value arrays and non-string
- * values will be converted to strings using a `toString()` method.
+ * Non-array inputs are rejected. Non-string entries will be converted to
+ * strings using a `toString()` method.
  *
  * @example
  * import { spawn } from "node:child_process";
@@ -109,6 +110,7 @@ export function quote(arg, options) {
  * @param {boolean} [options.flagProtection=true] Is flag protection enabled.
  * @param {boolean | string} [options.shell=true] The shell to escape for.
  * @returns {string[]} The quoted and escaped arguments.
+ * @throws {TypeError} The arguments are not an array.
  * @throws {TypeError} One of the arguments is not stringable.
  * @throws {Error} The shell is not supported or could not be found.
  * @throws {Error} Quoting is not supported with `shell: false`.

test/e2e/_common.js

@@ -46,25 +46,30 @@ export function getTestFn(shell) {
  * @returns {(boolean | string)[]} A list of `shell` option values.
  */
 export function getTestShells() {
+  const temp = path.resolve(import.meta.dirname, "..", "..", ".temp");
   const systemShells = constants.isWindows
     ? constants.shellsWindows
     : constants.shellsUnix;
 
-  const temp = path.resolve(import.meta.dirname, "..", "..", ".temp");
+  const shells = [false, ...systemShells];
 
-  const busyboxIndex = systemShells.indexOf(constants.binBusyBox);
+  const busyboxIndex = shells.indexOf(constants.binBusyBox);
   if (busyboxIndex !== -1) {
     if (constants.isMacOS) {
-      systemShells.splice(busyboxIndex, 1);
+      shells.splice(busyboxIndex, 1);
     } else {
-      systemShells[busyboxIndex] = path.resolve(temp, "busybox", "sh");
+      shells[busyboxIndex] = path.resolve(temp, "busybox", "sh");
     }
   }
 
   if (constants.isLinux) {
     const doubleLinkedShell = path.resolve(temp, "double-link", "link-to-link");
-    systemShells.push(doubleLinkedShell);
+    shells.push(doubleLinkedShell);
+  }
+
+  if (!constants.isMacOS) {
+    shells.push(true);
   }
 
-  return [false, ...systemShells];
+  return shells;
 }