Features

• Add execPath option which allows changing the path to the Node.js executable to use in child processes. (#377)

Breaking changes

• When the buffer option is false and stdout and stderr are piped, the promise returned by execa() will resolve only after those streams are fully read. This also applies to the all property if the all option is true. This concerns you only if you've explicitly set the buffer option to false. (#353)
• The all property is now undefined unless the all option is set to true. (#353)
• error.exitCodeName has been removed. (#375)
• Fix error.exitCode. Its value was previously based on error.errno which is incorrect. (#375)

Features

• Do not remove error.code property when it is defined (#375)
• Improve error messages (#375)
• Add error.originalMessage property (#373)

Bug fixes

• Fix errors being thrown when detached: true or cleanup: false is used (#360)
• Make execa compatible with Node.js 13.0.0-pre (#370)

Dependencies

• Upgrade npm-run-path from 3.0.0 to 4.0.0 (#376)
• Upgrade cross-spawn to 7.0.0 (#367)

Documentation

• Document the reasons why the returned promise might fail (#364)

Features

• Add error.originalMessage property (#373)

Documentation

• Document the reasons why the returned promise might fail (#364)

Dependencies

• Upgrade cross-spawn to 7.0.0 (#367)

Bug fixes

• Make execa compatible with Node.js 13.0.0-pre (#370) d268fd1

https://github.com/sindresorhus/execa/compare/v2.0.4...v2.0.5

Bug fixes

• Fix errors being thrown when detached: true or cleanup: false is used (#360) 211febe

https://github.com/sindresorhus/execa/compare/v2.0.3...v2.0.4

Bug fixes

• Add missing TypeScript definition for all (#345)

Documentation

• Add tip on how to execute the current package's binary (#339, #340)

Bug fixes

• Fix memory leak (#321, #330)
• Fix result.all not being constant across calls (#327, #330)

Bug fixes

• Correctly set the engines.node field in package.json. Supported Node versions are either ^8.12.0 or >=9.7.0 (#319, #323)

Documentation

• Improve the execa.command() documentation (#317)

Thanks to @GMartigny, @BendingBender, @tomsotte, @ammarbinfaisal, @zokker13, @stroncium, @satyarohith, @bradfordlemley, @coreyfarrell, @brandon93s, @dtinth, @papb for the great features and bug fixes they've contributed!

Please check the Medium article about this release!

Breaking changes

• Drop support for Node.js 6 (dce22670, #221)
• Remove execa.shell() and execa.shellSync(). The shell option should be used instead. (#219)
• Remove execa.stdout() and execa.stderr(). childProcessResult.stdout and childProcessResult.stderr should be used instead (#234)
• Remove error.code (number or string) in favor of error.exitCode (number) and error.exitCodeName (string) (#187, #250)
• Rename stripeEof option to stripFinalNewline (f8397ba9, 4d0dc88a, #238)
• Rename cmd (in childProcessResult and error) to command (#194)
• Default preferLocal option to false. If you are executing locally installed binaries, you'll need to manually specify preferLocal: true (#314)
• Ensure windowsHide option is always true, so that no window pops up on Windows. (8c886452)
• error.signal is now undefined instead of null when no signal was used (#193)
• Set error.killed to false when child process timed out (#227)
• Make error.killed always boolean (not undefined) (#229, #248)
• Ensure errors always have the same shape. (#276, #277, #283)
• error.stdout and error.stderr are now an empty string (instead of null) when the command failed. (#246)

Features

• Add TypeScript definition (#188, f2cb86ff, 7702b8ef, 4692dcd4, #251)
• Add execa.command() and execa.commandSync(). Those are the same as execa() except both file and arguments are specified in a single string. For example, execa('echo', ['unicorns']) is the same as execa.command('echo unicorns') (#182, #261, #262, #278, #279, #282)
• Retrieve interleaved stdout and stderr with childProcess.all and childProcessResult.all (#171, #264)
• Add execa.node() which (like child_process.fork()) allows you to execute a Node.js script as a child process (#200, #297, #299, #302, #303, #305, #306).
• If childProcess.kill() does not terminate a child process after 5 seconds, force it by sending SIGKILL. This can be configured using the forceKillAfterTimeout option. (#208, #272, #273, #280, #284, #285)
• Add childProcess.cancel() and error.isCanceled (#189, f24e7c72, #226, #309)
• error.stdout, error.stderr and error.all now contain the data that was sent before the child process exit. (#271)
• Improve error.message on child process failure (#180, #223, #230, #245, #269)
• Add .finally() to the child process promise (#174, 65139849)
• Increase maxBuffer option default value from 10 MB to 100 MB (#286)

Bug fixes

• Fix timeout option not working as expected (#199)
• Fix error.timedOut not working with execa.sync() (#249)
• Fix maxBuffer errors not using the same shape as the other errors (#266)
• Fix extendEnd option not working with shell option (#184)
• Fix stripFinalNewline option not applied on error properties (#240)
• Fix /q parameter not added when using cmd instead of cmd.exe (#203)
• Fix uncaught exception when using input option with a non-executable file (#212, #258)
• Fix errors on child processes waiting for stdout/stderr to complete (#270)
• Fix validating that the stdio option cannot be used together with stdin: 0 (#301).

Documentation

• Improve documentation (#158, #235, #237, #239, #241, #256)

Design

• Add a logo (#201)

Tests

• Fix various tests (f185a0e8, #185, #215, #216, #224, #218, #225, #231, #233, #247, #300)

Maintainers

• Add @ehmicky as an additional maintainer.

This is an alpha release for the upcoming 2.0.0.

Thanks to @GMartigny, @BendingBender, @tomsotte, @ammarbinfaisal, @zokker13, @stroncium, @satyarohith, @bradfordlemley, @coreyfarrell, @brandon93s, @dtinth, @papb for the great features and bug fixes they contributed!

Breaking changes

• Drop support for Node.js 6 (dce22670, #221)
• Remove execa.shell() and execa.shellSync(). The shell option should be used instead. (#219)
• Remove execa.stdout() and execa.stderr(). childProcessResult.stdout and childProcessResult.stderr should be used instead (#234)
• Remove error.code (number or string) in favor of error.exitCode (number) and error.exitCodeName (string) (#187, #250)
• Rename stripeEof option to stripFinalNewline (f8397ba9, 4d0dc88a, #238)
• Rename cmd (in childProcessResult and error) to command (#194)
• Default windowsHide option to true. This ensures no window pops up on Windows. (8c886452)
• error.signal is now undefined instead of null when no signal was used (#193)
• Set error.killed to false when child process timed out (#227)
• Make error.killed and error.isCanceled always boolean (not undefined) (#229, #248)
• Ensure errors always have the same shape. (#276, #277, #283)
• error.stdout and error.stderr are now an empty string (instead of null) when the command failed. (#246)

Features

• Add TypeScript definition (#188, f2cb86ff, 7702b8ef, 4692dcd4, #251)
• Add execa.command() and execa.commandSync(). Those are the same as execa() except both file and arguments are specified in a single string. For example, execa('echo', ['unicorns']) is the same as execa.command('echo unicorns') (#182, #261, #262, #278, #279, #282)
• Retrieve interleaved stdout and stderr with childProcess.all and childProcessResult.all (#171, #264)
• If childProcess.kill() does not terminate a child process after 5 seconds, force it by sending SIGKILL. This can be configured using the forceKillAftrerTimeout option. (#208, #272, #273, #280, #284, #285)
• Add childProcess.cancel() and error.isCanceled (#189, f24e7c72, #226)
• error.stdout, error.stderr and error.all now contain the data that was sent before the child process exit. (#271)
• Improve error.message on child process failure (#180, #223, #230, #245, #269)
• Add .finally() to the child process promise (#174, 65139849)
• Increase maxBuffer option default value from 10 MB to 100 MB (#286)

Bug fixes

• Fix timeout option not working as expected (#199)
• Fix error.timedOut not working with execa.sync() (#249)
• Fix maxBuffer errors not using the same shape as the other errors (#266)
• Fix extendEnd option not working with shell option (#184)
• Fix stripFinalNewline option not applied on error properties (#240)
• Fix /q parameter not added when using cmd instead of cmd.exe (#203)
• Fix uncaught exception when using input option with a non-executable file (#212, #258)
• Fix errors on child processes waiting for stdout/stderr to complete (#270)

Documentation

• Improve documentation (#158, #235, #237, #239, #241, #256)

Design

• Add a logo (#201)

Tests

• Fix various tests (f185a0e8, #185, #215, #216, #224, #218, #225, #231, #233, #247)

Maintainers

• Add @ehmicky as an additional maintainer.

This marks execa as stable. No actual changes since 0.11.0.