zx

In this release:

• Fully rewritten in TypeScript.
• Code coverage is now 99%.
• New within() API for async contexts.
• echo() now comes out of the box.
• Support for --eval flag.
• REPL support.

What's Changed

• Fixed question() types by @olebergen in https://github.com/google/zx/pull/437
• feat: transform some core types into ifaces to let them be extendable by plugins by @antongolub in https://github.com/google/zx/pull/439

New Contributors

• @olebergen made their first contribution in https://github.com/google/zx/pull/437

Full Changelog: https://github.com/google/zx/compare/6.2.4...6.2.5

What's Changed

• fix: rm redundant root ctx assignment by @antongolub in https://github.com/google/zx/pull/432

Full Changelog: https://github.com/google/zx/compare/6.2.3...6.2.4

What's Changed

• Fix promise ctx by @antongolub in https://github.com/google/zx/pull/427

Full Changelog: https://github.com/google/zx/compare/6.2.2...6.2.3

What's Changed

• fix getCtx() by @antongolub in https://github.com/google/zx/pull/425

Full Changelog: https://github.com/google/zx/compare/6.2.1...6.2.2

• Fixed $.verbose type.

This release adds async local contexts via ctx() and configurable logger.

This release contains updates of dependencies:

 minimist   ^1.2.5  →  ^1.2.6
 yaml      ^1.10.2  →  ^2.0.0

What's Changed

• Code coverage increased to 98% by @antongolub in https://github.com/google/zx/pull/359
• Fixed: do not rely on globals inside experimental.mjs by @antongolub in https://github.com/google/zx/pull/363

Full Changelog: https://github.com/google/zx/compare/6.0.6...6.0.7

What's Changed

• Added export for which package as global by @antongolub in https://github.com/google/zx/pull/347
• Introduced experimental withTimeout helper by @antongolub in https://github.com/google/zx/pull/355

Full Changelog: https://github.com/google/zx/compare/6.0.3...6.0.4

What's Changed

• Added new CLI --experimental flag by @antongolub in https://github.com/google/zx/pull/346
• Fixed bind cwd to spawn call by @antongolub in https://github.com/google/zx/pull/352

Full Changelog: https://github.com/google/zx/compare/6.0.1...6.0.2

What's Changed

• Added missing type declaration for quiet func by @svennergr in https://github.com/google/zx/pull/332
• Added optional delay for retry by @antongolub in https://github.com/google/zx/pull/335
• New config spawn func by @antongolub in https://github.com/google/zx/pull/333
• New config maxBuffer option by @antongolub in https://github.com/google/zx/pull/337
• Updated node-fetch to v3.2.3 by @antongolub in https://github.com/google/zx/pull/336

72c8cf0 Added experimental startSpinner() function.
53a215e Added the signal field to ProcessOutput.
bf88f50 Added quiet() function (#313).
51fb6d5 Improved experemental echo()function.

import {echo} from 'zx/experimental'

// The echo() can be used both ways: 
echo`Current branch is ${branch}.`
// or
echo('Current branch is', branch)

import {startSpinner} from 'zx/experimental'

let stop = startSpinner()
await $`long-running command`
stop()

let p = nothrow($`while true; do :; done`)
setTimeout(() => p.kill('SIGKILL'), 1000)
let {signal} = await p
assert.equal(signal, 'SIGKILL')

await quiet($`grep something from-file`)
// Command and output will not be displayed.

98a9abb Added new experimental retry & echo functions.
f8bb1c7 Fixed bug where running script without extension removes existing .mjs files (#276).
792370a Increased maxBuffer to 200 MiB.
7fafa26 Added known issues doc.

Example:

import {echo, retry} from 'zx/experimental'

let branch = await $`git branch --show-current`
echo`Current branch is ${branch}.`

let {stdout} = await retry(5)`curl localhost`

   __/\\\\\\\\\\\__/\\\____/\\\_     
    _\///////\\\/__\///\\\/\\\/__    
     ______/\\\/______\///\\\/____   
      ____/\\\/_________/\\\/\\\___  
       __/\\\\\\\\\\\__/\\\/\///\\\_ 
        _\///////////__\///____\///__

Updated dependencies

 chalk               ^4.1.2  →   ^5.0.0
 globby             ^12.0.1  →  ^13.1.1
 node-fetch          ^2.6.1  →   ^3.2.0

Added feature

Added YAML package.

let {foo} = YAML.parse('foo: bar')

Breaking changes

This release drops build of CommonJS version and support for .ts extension by zx bin.

TypeScript is still supported, for example, via ts-node:

node --loader ts-node/esm script.ts

Also, a new Node version requirement is >= 16.0.0.

• 3f7c8ca Fixed --version argv parsing.
• fe083c4 Fixed a process kill() with unhandled exception.
• 5f54045 Fixed cd() to work with relative paths.

let p = $`sleep 99999`
await sleep(100)
p.kill()

• Fixed export of zx/globals.
• Improved usage CLI output.

• Added missing path global 3f7e8fe3

• 49d4868 Added zx/globals 49d4868

import 'zx/globals'

In this release:

• Added kill() method 4915ff3
• Added path package ce69a84
• Added cjs support (#203)
• Changed: register globals only in zx binary 33aaae4

New examples:

• background-process.mjs
• interactive.mjs

let {stdin, stdout} = $`npm init`

for await (let chunk of stdout) {
  if (chunk.includes('package name:')) stdin.write('test\n')
}