Fixes

• Fix and document support for the {encoding: 'buffer'} option. It is the same as {encoding: null}, but preferred over it. (#572)

https://github.com/sindresorhus/execa/compare/v8.0.0...v8.0.1

Breaking

• Require Node.js 16.17.0 and later (#569)

https://github.com/sindresorhus/execa/compare/v7.2.0...v8.0.0

• Add cwd error property (#565) f57fdec

https://github.com/sindresorhus/execa/compare/v7.1.1...v7.2.0

Features

• Improve error message when $.sync(options)`command` is used instead of $(options).sync`command` (#551)

Bug fixes

• Fix argument concatenation when using $`command argument${value}` (#553)
• Fix default value of the stdin option when using $`command`: it should be inherit (#550)

Features

• Add $ method to write Node.js scripts like zx. For more information, please see this blog post, this section and this page. Thanks @aaronccasanova for this great feature!

import {$} from 'execa';

const branch = await $`git branch --show-current`;
await $`dep deploy --branch=${branch}`;

• Add .pipeStdout(), .pipeStderr() and .pipeAll() methods to redirect stdout/stderr to a file, a stream or another process.

// Similar to `echo unicorns > stdout.txt` in Bash
await execa('echo', ['unicorns']).pipeStdout('stdout.txt');

// Similar to `echo unicorns 2> stdout.txt` in Bash
await execa('echo', ['unicorns']).pipeStderr('stderr.txt');

// Similar to `echo unicorns &> stdout.txt` in Bash
await execa('echo', ['unicorns'], {all: true}).pipeAll('all.txt');

• Add inputFile option to use a file as stdin.

// Similar to `cat < stdin.txt` in Bash
const {stdout} = await execa('cat', {inputFile: 'stdin.txt'});
console.log(stdout);
//=> 'unicorns'

• Add verbose option to print each command on stderr before executing it. This can also be enabled by setting the NODE_DEBUG=execa environment variable in the current process.

> node file.js
unicorns
rainbows

> NODE_DEBUG=execa node file.js
[16:50:03.305] echo unicorns
unicorns
[16:50:03.308] echo rainbows
rainbows

Breaking

• Require Node.js 14 and later (#497) a09cbc0

Fixes

• Emit end event on streams when process fails (#518) 30c7a7a
• Fix incorrect execaNode signature in index.d.ts (#506) 1f7677c

https://github.com/sindresorhus/execa/compare/v6.1.0...v7.0.0

• Support AbortController (#490) c6e791a
• Allow cwd and localDir options to be URLs (#492) 93ab929

https://github.com/sindresorhus/execa/compare/v6.0.0...v6.1.0

Breaking

• Require Node.js 12.20 (#478) 7707880
• This package is now pure ESM. Please read this.
• Moved from a default export to named exports.
  • require('execa') → import {execa} from 'execa'
  • require('execa').sync → import {execaSync} from 'execa'
  • require('execa').command → import {execaCommand} from 'execa'
  • require('execa').commandSync → import {execaCommandSync} from 'execa'
  • require('execa').node → import {execaNode} from 'execa'

https://github.com/sindresorhus/execa/compare/v5.1.1...v6.0.0

• Fix error message when user passes a single array argument (#468) 2b9c0e1

https://github.com/sindresorhus/execa/compare/v5.1.0...v5.1.1

• Add .escapedCommand property to the results (#466) 712bafc

https://github.com/sindresorhus/execa/compare/v5.0.1...v5.1.0

• Fix timeout option validation (#463) 427c5c2

https://github.com/sindresorhus/execa/compare/v5.0.0...v5.0.1

Breaking

• Remove faulty emulated ENOENT error on Windows (#447) bdbd975
  This is only a breaking change if you depend on the exact error message.

Improvements

• Upgrade dependencies 5d64878

https://github.com/sindresorhus/execa/compare/v4.1.0...v5.0.0

• Remove --inspect & --inspect-brk from execArgv (#435) 8fd3f64

https://github.com/sindresorhus/execa/compare/v4.0.3...v4.1.0

• Fix use of floating number for the timeout and forceKillAfterTimeout options (#431) 9a157b3

https://github.com/sindresorhus/execa/compare/v4.0.2...v4.0.3

Bug fixes

• Fix with third-party promises (like bluebird) not working (#427)

Bug fixes

• Fix checking for Error instances (#423)

Breaking changes

• Require Node.js 10 (5a9c76f)
• Add stderr and stdout to error.message. A new property error.shortMessage is now available to retrieve the error message without stderr nor stdout (#397)

Bug fixes

• Fix childProcess.kill() not working with Electron (#400)

Features

• Add serialization option. That option was added to child_process methods in Node.js 13.2.0. (#392)

Features

• Allow setting the windowsHide option (#388). The option still defaults to true. However previously it could not be set to false.

Documentation

• Add tip on how to retry Execa on failure (#386).
• Improve examples (#385)

Thanks @justsml for helping improving the documentation!

Features

• Add error.signalDescription which is a human-friendly description of the signal that terminated the child process (if one did). That description is included in error messages as well. (#378)