v2 release post and changelog

[ehmicky]

I've created a Medium article for the upcoming major release (#191). Feel free to leave private notes on it if you think some sentences should be reworked or something is missing/wrong! It will remain in draft mode until 2.0.0 is published to npm, so please do not promote that link yet.

I'm also working on the changelog that we could include as the GitHub release description. I will update this post as new commits come in. Feel free to comment on it as well. Here it is:

---

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, Remove compatibility layer for util.getSystemErrorName() #221)
• Remove execa.shell() and execa.shellSync(). The shell option should be used instead. (Remove execa.shell() and execa.shellSync() #219)
• Remove execa.stdout() and execa.stderr(). childProcessResult.stdout and childProcessResult.stderr should be used instead (Remove execa.stdout() and execa.stderr() #234)
• Remove error.code (number or string) in favor of error.exitCode (number) and error.exitCodeName (string) (Distinguishing between error strings and error numbers #187, Remove error.code #250)
• Rename stripeEof option to stripFinalNewline (f8397ba9, 4d0dc88a, Remove deprecated option stripEof #238)
• Rename cmd (in childProcessResult and error) to command (Rename .cmd to .command #194)
• Default preferLocal option to false. If you are executing locally installed binaries, you'll need to manually specify preferLocal: true (Change default value of the preferLocal option to false #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 (Replace null by undefined #193)
• Set error.killed to false when child process timed out (Improve error.killed #227)
• Make error.killed always boolean (not undefined) (Make error.killed and error.isCanceled always boolean (not undefined) #229, Make error.killed more consistent #248)
• Ensure errors always have the same shape. (Fix shape of exceptions rejected by execa() #276, Fix shape of exceptions thrown by execa.sync() #277, Fix tests on Mac #283)
• error.stdout and error.stderr are now an empty string (instead of null) when the command failed. (Make stdout and stderr properties undefined instead of null #246)

Features

• Add TypeScript definition (Add TypeScript definition #188, f2cb86ff, 7702b8ef, 4692dcd4, Improve TypeScript tests #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') (Support single string input without using the shell option #182, Add execa.command() #261, Fix not being able to escape more than one space in commands #262, Rename joinedCommand variables to command #278, Fix documentation about result.command #279, Fix variable name bug (master failing) #282)
• Retrieve interleaved stdout and stderr with childProcess.all and childProcessResult.all (Add .all property with interleaved stdout and stderr #171, Upgrade merge-stream from 1.0.1 to 2.0.0 #264)
• Add execa.node() which (like child_process.fork()) allows you to execute a Node.js script as a child process (Add .node() method #200, Fix documentation of execa.node() #297, Rename nodeArguments to nodeOptions #299, Refactor stdio option #302, Refactor stdio option for execa.node() #303, Refactor entry point of execa.node() #305, Rename variables in stdio file #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. (Add feature to retry process killing after specified duration #208, Refactor kill() #272, Remove try/catch inside kill() #273, Refactor kill() again #280, Refactor tests of kill() #284, Merge forceKill and forceKillAfter options #285)
• Add childProcess.cancel() and error.isCanceled (Make the spawned process cancelable #189, f24e7c72, Simplify cancel() method #226, Improve/refactor .cancel() #309)
• error.stdout, error.stderr and error.all now contain the data that was sent before the child process exit. (Add buffered data to error.stdout, error.stderr and error.all #271)
• Improve error.message on child process failure (Improve returned error.message #180, Remove dead code related to exit code names #223, Make error messages more consistent #230, Separate original error message with a newline #245, Improve error messages when an error event is emitted #269)
• Add .finally() to the child process promise (Make the Promise interface complete by adding a .finally() method #174, 65139849)
• Increase maxBuffer option default value from 10 MB to 100 MB (Change maxBuffer default value from 10 MB to 100 MB #286)

Bug fixes

• Fix timeout option not working as expected (Fix timeout option not leaving early when on sleep mode #199)
• Fix error.timedOut not working with execa.sync() (Fix error.timedOut not working with execa.sync() #249)
• Fix maxBuffer errors not using the same shape as the other errors (Make errors more consistent #266)
• Fix extendEnd option not working with shell option (Fix extendEnv option not working with shell option #184)
• Fix stripFinalNewline option not applied on error properties (Fix stripFinalNewline not applied on error.stdout|stderr|all #240)
• Fix /q parameter not added when using cmd instead of cmd.exe (Add /q option to cmd as well as cmd.exe on Windows #203)
• Fix uncaught exception when using input option with a non-executable file (Fix non-executable execution with input option #212, Add TODO comment about spawned.stdin bug being fixed in Node.js 12 #258)
• Fix errors on child processes waiting for stdout/stderr to complete (Child process errors should reject the promise right away #270)
• Fix validating that the stdio option cannot be used together with stdin: 0 (Do not allow stdin: 0 combined with stdio #301).

Documentation

• Improve documentation (Document encoding: null #158, Improve a readme example #235, Improve readme Why section #237, Improve the API section of the readme #239, Reorder properties of results and errors #241, Separate core options from execa-specific options #256)

Design

• Add a logo (Add a logo #201)

Tests

• Fix various tests (f185a0e8, Fix Windows test related to shell option #185, Fix options.detached test #215, Improve test for options.preferLocal #216, Fix test for options.cleanup #224, Fix test for options.localDir #218, Improve cleanup option (code quality, tests, documentation) #225, Fix randomly failing CI tests #231, Improve tests for the reject option #233, Make tests more consistent (code refactoring) #247, Simplify tests for stdio #300)

Maintainers

• Add @ehmicky as an additional maintainer.

[sindresorhus]

This looks great. Thanks for doing the work. I've added a couple of comments to the Medium draft, but it's already awesome.

Migrate from AppVeyor to Travis CI for Windows (#167)

This is not really relevant to the user.

[ehmicky]

Thanks a lot! When we do the major release, could you please:

• Give me some heads up, so I can publish the Medium article at the same time. I will also promote it on social media (anyone involved in this release will be welcome/encouraged to do so as well!)
• Copy/paste the CHANGELOG from the first comment (I update it on every new commit) to the Releases notes.

[sindresorhus]

@ehmicky Or better yet, you can do the release? ;) (You have publish access) When we're ready, just do np and then choose major.

[ehmicky]

Do I have npm publish access? If I do, then yes I can do that 👍

We still have few items in the milestone though.

[sindresorhus]

Do I have npm publish access?

Yes

[lolipop99]

@magicdawn hold on tight, we're working on that next release :)

@ehmicky when will the new version be released。expecting... thx

[ehmicky]

@lolipop99 thanks for your interest in the new version! We don't have a deadline (like most open source projects). We have a list of items until the release though: you can follow this milestone.

[magicdawn]

@sindresorhus
I get the point.
But I guess point out the readme is for the next version like got do will be a great help to users.

[sindresorhus]

@magicdawn No. That's just enabling users to not know how things work. I added it to the Got readme because I knew it was going to come up, but I wish I hadn't. People should learn how GitHub works.

[ehmicky]

I agree with @sindresorhus that when I get on a GitHub repository which shows different documentation for different versions, I find it a little confusing. Instead I'm always assuming the documentation is of the latest version.

Now this assumes versions are released fast, which has not been the case for this major release. The problems are:

1. we have been working on several breaking changes at once. Those should be mostly solved now except for Add buffered data to error.stdout, error.stderr and error.all #271
2. we have few big PRs that have taken some time to review
3. we have a hard-to-resolve issue at Fix repeated execPath directory npm-run-path#5 that's in a deadlock at the moment

[DavidWells]

Awesome work on this!

Was trying to use execa.command and it wasn't working. Realized I was on v1.0.0 😅whoopsies

Ya'll rock! Excited for release on npm

[tunnckoCore]

Cool. Sounds like a big one! 🎉

In the past 2-3 years, I was maintaining execa-pro/@tunnckocore/execa exactly because of the .command thingy and the ability to pass multiple commands as array of strings (meaning they will run in series - example), it was just a thin wrapper around 30 lines.

And the #153 was the reason to use .shell when needed.

Waiting for that release for sure! 🌮

[ehmicky]

@tunnckoCore great to hear! Feel free to checkout our implementation for execa.command() (it's only 15 lines of code here) and post an issue/PR if you think there's anything wrong with our current solution!

[tunnckoCore]

Yea, I've seen it, it looks like the same thing, I will try it.
I'm jumping around the npm-run-path problem now :)

[sindresorhus]

There's an alpha version of v2 out now: https://github.com/sindresorhus/execa/releases/tag/v2.0.0-alpha.0

Install it with npm install execa@next.

Please share feedback here or in new issues.

[tunnckoCore]

Sweeeet! 🌮 🎉

Works great for now.

[ehmicky]

We just released 2.0.0. Please check the Medium article!