Update execa 9.1.0 → 9.2.0 (minor)

[depfu]

Here is everything you need to know about this update. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ execa (9.1.0 → 9.2.0) · Repo

Release Notes

9.2.0

This release includes a new set of methods to exchange messages between the current process and a Node.js subprocess, also known as "IPC". This allows passing and returning almost any message type to/from a Node.js subprocess. Also, debugging IPC is now much easier.

Moreover, a new gracefulCancel option has also been added to terminate a subprocess gracefully.

For a deeper dive-in, please check and share the release post!

Thanks @iiroj for your contribution, @SimonSiefke and @adymorz for reporting the bugs fixed in this release, and @karlhorky for improving the documentation!

Deprecations

• Passing 'ipc' to the stdio option has been deprecated. It will be removed in the next major release. Instead, the ipc: true option should be used. (#1056)

- await execa('npm', ['run', 'build'], {stdio: ['pipe', 'pipe', 'pipe', 'ipc']});
+ await execa('npm', ['run', 'build'], {ipc: true});

• The execaCommand() method has been deprecated. It will be removed in the next major release. If most cases, the template string syntax should be used instead.

- import {execaCommand} from 'execa';
+ import {execa} from 'execa';
- await execaCommand('npm run build');

+ await execanpm run build;
const taskName = 'build';

- await execaCommand(npm run ${taskName});

+ await execanpm run ${taskName};
const commandArguments = ['run', 'task with space'];

await execanpm ${commandArguments};

If the file and/or multiple arguments are supplied as a single string, parseCommandString(command) can split that string into an array. More info. (#1054)

- import {execaCommand} from 'execa';
+ import {execa, parseCommandString} from 'execa';
const commandString = 'npm run task';

- await execaCommand(commandString);

+ const commandArray = parseCommandString(commandString); // ['npm', 'run', 'task']

+ await execa${commandArray};
// Or alternatively:

const [file, ...commandArguments] = commandArray;

await execa(file, commandArguments);

Features

• Add gracefulCancel option and getCancelSignal() method to terminate a subprocess gracefully. error.isGracefullyCanceled was also added. (#1109)
• Add error.isForcefullyTerminated. It is true when the subprocess was terminated by the forceKillAfterDelay option. (#1111)
• New methods to simplify exchanging messages between the current process and the subprocess. More info. (#1059, #1061, #1076, #1077, #1079, #1082, #1083, #1086, #1087, #1088, #1089, #1090, #1091, #1092, #1094, #1095, #1098, #1104, #1107)
  • The current process sends messages with subprocess.sendMessage(message) and receives them with subprocess.getOneMessage(). subprocess.getEachMessage() listens to multiple messages.
  • The subprocess uses sendMessage(message), getOneMessage() and getEachMessage() instead. Those are the same methods, but imported directly from the 'execa' module.
• The ipcInput option sends an IPC message from the current process to the subprocess as it starts. This enables passing almost any input type to a Node.js subprocess. (#1068)
• The result.ipcOutput array contains all the IPC messages sent by the subprocess to the current process. This enables returning almost any output type from a Node.js subprocess. (#1067, #1071, #1075)
• The error message now contains every IPC message sent by the subprocess. (#1067)
• The verbose: 'full' option now logs every IPC message sent by the subprocess, for debugging. More info here and there. (#1063)

Types

• Add ExecaMethod, ExecaNodeMethod and ExecaScriptMethod, ExecaSyncMethod and ExecaScriptSyncMethod types. (#1066)
• Export the Message type, for IPC. (#1059)
• Fix type of forceKillAfterDelay: true option. (#1116)

Bug fixes

• Fix passing a {file} to both the stdin and the stdout or stderr options. (#1058)
• Fix multiple minor problems with the cancelSignal option. (#1108)
• Fix accidental publishing of Vim backup files. (#1074)
• Fix engines.node field in package.json. Supported Node.js version is ^18.19.0 or >=20.5.0. (by @iiroj) (#1101)

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 50 commits:

• 9.2.0
• Send fewer requests with link checking (#1122)
• Fix typo in IPC documentation (#1121)
• Automatically check Markdown links (#1120)
• Export TypeScript types for the `execa` method (#1066)
• Fix broken Markdown links (#1119)
• Improve speed of types (#1118)
• Improve documentation of Execa methods (#1115)
• Refactor types of Execa methods (#1114)
• Add more type tests (#1117)
• Fix type of `forceKillAfterDelay` option (#1116)
• Document passing `[]` or `''` to template string syntax (#1113)
• Add `gracefulCancel` option (#1109)
• Fix "Preventing exceptions" example (#1110)
• Add `error.isForcefullyTerminated` (#1111)
• Add `reference` option to `getOneMessage()` and `getEachMessage()` (#1107)
• Improve `cancelSignal` option (#1108)
• Improve documentation of signal handling (#1105)
• Fix deadlocks with IPC (#1104)
• Fix required Node.js semver range to "^18.19.0 || >=20.5.0" (#1101)
• Improve bash vs zx vs Execa documentation (#1100)
• Add `strict` option to `sendMessage()` (#1098)
• Improve documentation of shell escaping (#1096)
• Add tests for I/O errors during `sendMessage()` (#1095)
• Improve `buffer: false` option with IPC (#1094)
• Improve `buffer: false` behavior with IPC (#1092)
• Handle exceptions from the `filter` option of `getOneMessage()` (#1091)
• Improve IPC error messages (#1090)
• Refactor reference counting with IPC (#1089)
• Better error message on IPC `EPIPE` (#1088)
• Debounce `message` events (#1087)
• Do not disconnect IPC on `error` event on process (#1086)
• Add more IPC-related tests (#1083)
• Refactor parallel tests (#1084)
• Fix `break` statement with `subprocess.getEachMessage()` (#1082)
• Fix some randomly failing tests (#1080)
• Improve IPC documentation (#1079)
• Add `exchangeMessage()` method (#1077)
• Add `filter` option to `getOneMessage()` (#1076)
• Rename `result.ipc` to `result.ipcOutput` (#1075)
• Do not publish Vim backup files (#1074)
• Add `ipcInput` option (#1068)
• Fix type of `result.ipc` (#1071)
• Add `result.ipc`/`error.ipc` (#1067)
• Log IPC messages with `verbose: 'full'` (#1063)
• Add more IPC-related tests (#1061)
• Improve documentation about shells (#1060)
• Add promise-based IPC (#1059)
• Fix using files in both input and output (#1058)
• Add `parseCommandString()` (#1054)

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)

[sebbo2002]

🎉 This PR is included in version 4.0.3-develop.21 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release
• v4.0.3-develop.21

Your semantic-release bot 📦🚀

[sebbo2002]

🎉 This issue has been resolved in version 4.0.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release
• v4.0.3

Your semantic-release bot 📦🚀