8.2.2

What's Changed

• test: stdio inherit by @antongolub in #941
• fix: handle nullable stdout/stderr by @antongolub in #943

Full Changelog: 8.2.1...8.2.2

8.2.1

• #936 fixes endless streams piping
• #930 enables custom extensions support

8.2.0

Pipes supercharge today! 🚀

Features

• Delayed piping. You can fill dependent streams at any time during the origin process lifecycle (even when finished) without losing data. #914

const result = $`echo 1; sleep 1; echo 2; sleep 1; echo 3`
const piped1 = result.pipe`cat`
let piped2

setTimeout(() => {
  piped2 = result.pipe`cat`
}, 1500)

await piped1
assert.equal((await piped1).toString(), '1\n2\n3\n')
assert.equal((await piped2).toString(), '1\n2\n3\n')

• Promisified streams. #921 #922 #923 #928

const file = tempfile()
const fileStream = fs.createWriteStream(file)
const p = $`echo "hello"`
  .pipe(
    new Transform({
      transform(chunk, encoding, callback) {
        callback(null, String(chunk).toUpperCase())
      },
    })
  )
  .pipe(fileStream)

p instanceof WriteStream             // true
await p === fileStream               // true
(await fs.readFile(file)).toString() // 'HELLO\n'

Chore

• Code improvements #924 #925
• Tests enhancements #919 #920 #926 #927

8.1.9

Today's release is a minor update that includes:

Enhancements

• We have replaced ProcessOutput fields with lazy getters to reduce mem consumption #903, #908
• Reduced ReDos risks for codeblock patterns #906
• Kept argv reference on update #916
• Strengthened Shell interface to properly handle sync mode #915:

expectType<ProcessPromise>($`cmd`)
expectType<ProcessPromise>($({ sync: false })`cmd`)
expectType<ProcessOutput>($({ sync: true })`cmd`)
expectType<ProcessOutput>($.sync`cmd`)

Fixes

• Corrected stdall fill for $.sync calls: #911, #912

8.1.8

• Apply the proper TeplateStringArray detection #904, #905
• PromiseProcess got lazy getters to optimize mem usage #903

8.1.7

Step by step on the road to improvements

Fixes

Finally, we've fixed the issue with piped process rejection #640 #899:

const p1 = $`exit 1`.pipe($`echo hello`)
try {
  await p1
} catch (e) {
  assert.equal(e.exitCode, 1)
}

const p2 = await $({ nothrow: true })`echo hello && exit 1`.pipe($`cat`)
assert.equal(p2.exitCode, 0)
assert.equal(p2.stdout.trim(), 'hello')

Enhancements

Added cmd display to ProcessPromise #891:

const foo = 'bar'
const p = $`echo ${foo}`

p.cmd // 'echo bar'

and duration field to ProcessOutput #892:

const p = $`sleep 1`.nothrow()
const o = await p

o.duration // ~1000 (in ms)

Enabled zurk-like pipe string literals #900:

const p = await $`echo foo`.pipe`cat`
p.stdout.trim() // 'foo'

8.1.6

Improvements & Fixes

• The $.preferLocal option now also accepts a directory #886, #887.

$.preferLocal = true             // injects node_modules/.bin to the $PATH
$.preferLocal = '/foo/bar'       // attaches /foo/bar to the $PATH
$.preferLocal = ['/bar', '/baz'] // now the $PATH includes both /bar and /baz

Why not just $.env['PATH'] = 'extra:' + '$.env['PATH']?
Well, the API internally does the same, but also handles the win paths peculiarities.

• Provided $.killSignal option for the symmetry with the $.timeoutSignal. You can override the default termination flow #885:

$.killSignal = 'SIGKILL'

const p = $({nothrow: true})`sleep 10000`
setTimeout(p.kill, 100)
  
(await p).signal // SIGKILL

• $ opt presets became chainable #883:

const $$ = $({ nothrow: true })
assert.equal((await $$`exit 1`).exitCode, 1)

const $$$ = $$({ sync: true }) // Both {nothrow: true, sync: true} are applied
assert.equal($$$`exit 2`.exitCode, 2)

• Enhanced the internal Duration parser #884:

const p = $({timeout: '1mss'})`sleep 999` // raises an error now

• Abortion signal listeners are now removed after the process completes #881, #889, zurk#12, zurk#13.
• Extended integration tests matrix, added nodejs-nightly builds and TS dev snapshots #888

8.1.5

We've rolled out a new release!

Fixes

• Added the minimist typings to the dts bundle. #872 brings the fix.
• Re-enabled the YAML extra
  API. #870 #879

Chores

• Clarified cd(), within() and syncProcessCwd() interactions. #878
• Included mention of the cwd option in the documentation. #868
• Test enhancements. #877 #880

8.1.4

We continue optimizing bundles and CI/CD pipelines.

• Update @webpod/ps to v0.0.0-beta.7 to sync internal zurk version. #855
• Split vendor chunk to reduce the zx/core entry size. #856
• Add bundle size check. #857
• Refactor the testing flow, remove duplicated tasks. #861
• Add missing types for the global defaults. #864
• Omit redundant YAML API extras. #866

Which gives us: 897 kB → 829 kB (-7.58%)

8.1.3

Nothing special today. We just keep improving the implementation.

Features

• ESM support is now available for Node.js v12 (previously was cjs only):
  
  ^{#824, #827, #828}

import {$} from 'zx'

• zx/cli exports its inners to allow more advanced usage.
  Imagine, your own CLI tool that uses zx as a base:
  
  ^#828

#!/usr/bin/env node

import './index.mjs'
import {main} from 'zx/cli'

main()

• Provide intermediate store configuration for fine-grained control of memory usage.
  
  ^{#650, #849}

const getFixedSizeArray = (size) => {
  const arr = []
  return new Proxy(arr, {
    get: (target, prop) =>
      prop === 'push' && arr.length >= size
        ? () => {}
        : target[prop],
  })
}
const store = {
  stdout: getFixedSizeArray(1),
  stderr: getFixedSizeArray(1),
  stdall: getFixedSizeArray(0),
}

const p = await $({ store })`echo foo`

p.stdout.trim() //  'foo'
p.toString()    // ''

• Introduced sync methods for ps:
  
  ^#840

import { ps } from 'zx'

const list1 = await ps()
const list2 = await tree()

// new methods
const list3 = ps.sync()
const list4 = tree.sync()

Chore

• $.log accepts kind: 'custom' #834
• Describe $.verbose and $.quiet modes internals #835
• Mention quotePowerShell in docs #851
• Finally fixed the annoying flaky problem of the process end detection in Bun #839, coderef
• Suppress async_hooks.createHook warning on bun #848
• Remove node-abort-controller in favor of built-in node-fetch polyfill #842
• Add missing global types #853