[Snyk] Upgrade execa from 7.2.0 to 9.1.0

[YoutacRandS-VA]

This PR was automatically created by Snyk using the credentials of a real user.


Snyk has created this PR to upgrade execa from 7.2.0 to 9.1.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

---

⚠️ Warning: This PR contains major version upgrade(s), and may be a breaking change.

• The recommended version is 6 versions ahead of your current version.

• The recommended version was released on a month ago.

Release notes

Package name: execa

• 9.1.0 - 2024-05-13
  

  Features (types)

  • Export TemplateExpression type. (#1049)
• 9.0.2 - 2024-05-10
  

  Bug fixes (types)

  • Do not require using --lib dom for TypeScript users (#1043, #1044)
  • Fix type of the reject option (#1046)
• 9.0.1 - 2024-05-09
  

  Bug fixes (types)

  • Fix types not being importable (#1033) 3bdab60
  • Fix complexity bug with types (#1037) 6cc519b
  • Fix complexity bug with types (#1035) fee011d
• 9.0.0 - 2024-05-08
  

  This major release brings many important features including:

  • Split the output into lines, or progressively iterate over them.
  • Transform or filter the input/output using simple functions.
  • Print the output to the terminal while still retrieving it programmatically.
  • Redirect the input/output from/to a file.
  • Advanced piping between multiple subprocesses.
  • Improved verbose mode, for debugging.
  • More detailed errors, including when terminating subprocesses.
  • Enhanced template string syntax.
  • Global/shared options.
  • Web streams and Transform streams support.
  • Convert the subprocess to a stream.
  • New documentation with many examples.

  Please check the release post for a high-level overview! For the full list of breaking changes, features and bug fixes, please read below.

  Thanks @ younggglcy, @ koshic, @ am0o0 and @ codesmith-emmy for your help!

  ---

  One of the maintainers @ ehmicky is looking for a remote full-time position. Specialized in Node.js back-ends and CLIs, he led Netlify Build, Plugins and Configuration for 2.5 years. Feel free to contact him on his website or on LinkedIn!

  ---

  Breaking changes (not types)

  • Dropped support for Node.js version <18.19.0 and 20.0.0 - 20.4.0. (834e372)

  • When the encoding option is 'buffer', the output (result.stdout, result.stderr, result.all) is now an Uint8Array instead of a Buffer. For more information, see this blog post. (by @ younggglcy) (#586)

  const {stdout} = await execa('node', ['file.js'], {encoding: 'buffer'});
  console.log(stdout); // This is now an Uint8Array

  • Renamed some of the allowed values for the encoding option. (#586, #928)
  - await execa('node', ['file.js'], {encoding: null});
  + await execa('node', ['file.js'], {encoding: 'buffer'});

- await execa('node', ['file.js'], {encoding: 'utf-8'});
+ await execa('node', ['file.js'], {encoding: 'utf8'});

- await execa('node', ['file.js'], {encoding: 'UTF8'});
+ await execa('node', ['file.js'], {encoding: 'utf8'});

- await execa('node', ['file.js'], {encoding: 'utf-16le'});
+ await execa('node', ['file.js'], {encoding: 'utf16le'});

- await execa('node', ['file.js'], {encoding: 'ucs2'});
+ await execa('node', ['file.js'], {encoding: 'utf16le'});

- await execa('node', ['file.js'], {encoding: 'ucs-2'});
+ await execa('node', ['file.js'], {encoding: 'utf16le'});

- await execa('node', ['file.js'], {encoding: 'binary'});
+ await execa('node', ['file.js'], {encoding: 'latin1'});

• Passing a file path to subprocess.pipeStdout(), subprocess.pipeStderr() and subprocess.pipeAll() has been removed. Instead, a {file: './path'} object should be passed to the stdout or stderr option. (#752)

- await execa('node', ['file.js']).pipeStdout('output.txt');
+ await execa('node', ['file.js'], {stdout: {file: 'output.txt'}});

- await execa('node', ['file.js']).pipeStderr('output.txt');
+ await execa('node', ['file.js'], {stderr: {file: 'output.txt'}});

- await execa('node', ['file.js']).pipeAll('output.txt');
+ await execa('node', ['file.js'], {
+ stdout: {file: 'output.txt'},
+ stderr: {file: 'output.txt'},
+});

• Passing a writable stream to subprocess.pipeStdout(), subprocess.pipeStderr() and subprocess.pipeAll() has been removed. Instead, the stream should be passed to the stdout or stderr option. If the stream does not have a file descriptor, ['pipe', stream] should be passed instead. (#752)

- await execa('node', ['file.js']).pipeStdout(stream);
+ await execa('node', ['file.js'], {stdout: ['pipe', stream]});

- await execa('node', ['file.js']).pipeStderr(stream);
+ await execa('node', ['file.js'], {stderr: ['pipe', stream]});

- await execa('node', ['file.js']).pipeAll(stream);
+ await execa('node', ['file.js'], {
+ stdout: ['pipe', stream],
+ stderr: ['pipe', stream],
+});

• The subprocess.pipeStdout(), subprocess.pipeStderr() and subprocess.pipeAll() methods have been renamed to subprocess.pipe(). The command and its arguments can be passed to subprocess.pipe() directly, without calling execa() a second time. The from piping option can specify 'stdout' (the default value), 'stderr' or 'all'. (#757)

- await execa('node', ['file.js']).pipeStdout(execa('node', ['other.js']));
+ await execa('node', ['file.js']).pipe('node', ['other.js']);

- await execa('node', ['file.js']).pipeStderr(execa('node', ['other.js']));
+ await execa('node', ['file.js']).pipe('node', ['other.js'], {from: 'stderr'});

- await execa('node', ['file.js']).pipeAll(execa('node', ['other.js']));
+ await execa('node', ['file.js']).pipe('node', ['other.js'], {from: 'all'});

• Renamed the signal option to cancelSignal. (#880)

- await execa('node', ['file.js'], {signal: abortController.signal});
+ await execa('node', ['file.js'], {cancelSignal: abortController.signal});

• Renamed error.killed to error.isTerminated. (#625)

try {
	await execa('node', ['file.js']);
} catch (error) {
- if (error.killed) {
+ if (error.isTerminated) {
		// ...
	}
}

• subprocess.cancel() has been removed. Please use either subprocess.kill() or the cancelSignal option instead. (#711)

- subprocess.cancel();
+ subprocess.kill();

• Renamed the forceKillAfterTimeout option to forceKillAfterDelay. Also, it is now passed to execa() instead of subprocess.kill(). (#714, #723)

- const subprocess = execa('node', ['file.js']);
- subprocess.kill('SIGTERM', {forceKillAfterTimeout: 1000});
+ const subprocess = execa('node', ['file.js'], {forceKillAfterDelay: 1000});
+ subprocess.kill('SIGTERM');

• The verbose option is now a string enum instead of a boolean. false has been renamed to 'none' and true has been renamed to 'short'. (#884)

- await execa('node', ['file.js'], {verbose: false});
+ await execa('node', ['file.js'], {verbose: 'none'});

- await execa('node', ['file.js'], {verbose: true});
+ await execa('node', ['file.js'], {verbose: 'short'});

• The execPath option has been renamed to nodePath. It is now a noop unless the node option is true. Also, it now works even if the preferLocal option is false. (#812, #815)

- await execa('node', ['file.js'], {execPath: './path/to/node'});
+ await execa('node', ['file.js'], {nodePath: './path/to/node'});

• The default value for the serialization option is now 'advanced' instead of 'json'. In particular, when calling subprocess.send(object) with an object that contains functions or symbols, those were previously silently removed. Now this will throw an exception. (#905)

- subprocess.send({example: true, getExample() {}});
+ subprocess.send({example: true});

• If subprocess.stdout, subprocess.stderr or subprocess.all is manually piped, the .pipe() call must now happen as soon as subprocess is created. Otherwise, the output at the beginning of the subprocess might be missing. (#658, #747)

const subprocess = execa('node', ['file.js']);
- setTimeout(() => {
	subprocess.stdout.pipe(process.stdout);
- }, 0);

• Signals passed to subprocess.kill() and to the killSignal option cannot be lowercase anymore. (#1025)

- const subprocess = execa('node', ['file.js'], {killSignal: 'sigterm'});
+ const subprocess = execa('node', ['file.js'], {killSignal: 'SIGTERM'});

- subprocess.kill('sigterm');
+ subprocess.kill('SIGTERM');

Features

Execution

• Use the template string syntax with any method (including execa()), as opposed to only $. Conversely, $ can now use the regular array syntax. (#933)
• A command's template string can span multiple lines. (#843)
• Share options between multiple calls, or set global options, by using execa(options). (#933, #965)
• Pass a file URL (as opposed to a file path string) to execa(), execaNode(), the inputFile option, the nodePath option or the shell option. (#630, #631, #632, #635)

Text lines

• Split the output into text lines by using the lines option. (#741, #929, #931, #948, #951, #957)
• Subprocess is now an async iterable, iterating over the output lines while the subprocess is running. (#923)

Piping multiple subprocesses

• Simpler syntax: pass the command directly to subprocess.pipe() without calling execa(). A template string can also be used. (#840, #859, #864)
• Wait for both subprocesses to complete. Error handling has been improved too. (#757, #778, #834, #854)
• Retrieve the result of each subprocess (not only the last one) by using result.pipedFrom and error.pipedFrom. (#834)
• Pipe 1 or many subprocesses to 1 or many subprocesses. (#834)
• Pipe subprocesses using other file descriptors than stdin/stdout/stderr by using the from and to piping options. (#757, #834, #903, #920)
• Cancel piping subprocesses by using the unpipeSignal piping option. (#834, #852)

Input/output

• Pass an array with multiple values to the stdin, stdout and stderr options. For example, stdout: ['inherit', 'pipe'] prints the output to the terminal while still returning it as result.stdout. (#643, #765, #941, #954)
• Redirect the input/output from/to a file by passing a {file: './path'} object or a file URL to the stdin, stdout or stderr option. (#610, #614, #621, #671, #1004)
• Transform or filter the input/output by passing a generator function to the stdin, stdout or stderr option. (#693, #697, #698, #699, #709, #736, #737, #739, #740, #746, #748, #755, #756, #780, #783, #867, #915, #916, #917, #919, #924, #926, #945, #969)
• Provide some binary input by passing an Uint8Array to the input or stdin option. (834e372,