feat: configurable maxBuffer spawn option

[antongolub]

Maintainer: 200 Mb is enough for stdout. No one will use zx to test ELK, spark and kuber orchestration.
QIWI: Hold my beer )

• Tests pass
• Appropriate changes to README are included in PR

[antonmedv]

I'm not sure it should go into the library. It's really easy to implement in client code:

let p = $`...`
setTimeout(() => p.kill('SIGINT').catch(_=>_), 1000)
await p

[antongolub]

Aha, it's possible to control timeout from a script, but it seems more convenient to hide this logic in API inners just like cp.spawn({timeout: 1000}) does.

[antonmedv]

Let’s think more of zx’s timeout api. In CP timeout is per execution. And here it will be globally.

[antonmedv]

Also, I'm not really like this API. timeout & killSignal seems not related here, but they are.

[antongolub]

https://nodejs.org/api/child_process.html#child_processspawncommand-args-options

[antonmedv]

I mean the difference between:

$.spawn.timeout = 100
$.spawn.killSignal = 'SIGKILL'

and

{ timeout: 100
  killSignal: 'SIGKILL'}

[antonmedv]

Probably we can introduce another experimental func (as retry):

await cutoff('SIGKILL', 1000)`...`

[antongolub]

What's about $.f({...}) factory?

$.f({maxBuffer: 1024 * 1024 * 1024})`cmd arg1 arg2`
//...
$.nothrow = $.f({noThrow: true})
$.quiet = $.f({quiet: true})
$.retry5 = $.f({retry: 5, delay: 1000})
$.timeout1s = $.f({timeout: 1000})
//...
$.custom = $.f({timeout: 10000, maxBuffer: 1024 * 1024 * 1024, retry: 5, delay: 1000, quiet: true, spawn: customSpawn})
// and finally
global.$ = $.custom

or even factory of factories:

$.custom = $.ff({maxBuffer: $.ff.0, timeout: $.ff.1})
$.custom(1024 * 1024, 1000)`cmd arg1 arg2`
$.retry = $.ff({retry: $.ff.0, delay: $.ff.1})
$.retry(5, 1000)`cmd arg1`

[antongolub]

Or maybe introduce $.options?

Object.assign($.options, {
    quiet: true,
    retry: 5,
    delay: 1000
})

$`cmd args`

[antonmedv]

I was thinking about it too for a while.

What about:

let $$ = quiet(nothrow($))

[antongolub]

And store options in IIFE contexts? yep, it might work too.

[antonmedv]

Let’s merge maxBuffers and think about timeouts API in issues?

[antongolub]

np, I'll create another PR for the timeout option.

[antongolub]

Let's release these changes.

@antonmedv, I still suggest to configure cicd to automate this task. Should I create a PR?