feat: add default spawn properties override: timeout, killSignal …

…and `maxBuffer`

README.md

@@ -315,6 +315,8 @@ Or use a CLI argument: `--shell=/bin/bash`
 #### `$.spawn`
 
 Specifies a `spawn` api. Defaults to `require('child_process').spawn`.
+You may also assign `spawn.timeout`, `spawn.maxBuffer` and `spawn.killSignal`
+to override the default spawn options for all calls.
 
 #### `$.prefix`
 

index.d.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {ChildProcess, spawn} from 'child_process'
+import {ChildProcess, spawn, SpawnOptions} from 'child_process'
 import {Readable, Writable} from 'stream'
 import * as _fs from 'fs-extra'
 import * as _globby from 'globby'
@@ -30,7 +30,11 @@ interface $ {
   shell: string
   prefix: string
   quote: (input: string) => string
-  spawn: typeof spawn
+  spawn: typeof spawn & {
+    maxBuffer?: number | undefined
+    timeout?: SpawnOptions['timeout']
+    killSignal?: SpawnOptions['killSignal']
+  }
 }
 
 export interface ProcessPromise<T> extends Promise<T> {

index.mjs

@@ -56,7 +56,8 @@ export function registerGlobals() {
 }
 
 export function $(pieces, ...args) {
-  let {verbose, shell, prefix} = $
+  let {verbose, shell, prefix, spawn} = $
+  let {timeout, killSignal, maxBuffer = 200 * 1024 * 1024 /* 200 MiB*/} = spawn
   let __from = (new Error().stack.split(/^\s*at\s/m)[2]).trim()
 
   let cmd = pieces[0], i = 0
@@ -80,15 +81,20 @@ export function $(pieces, ...args) {
       printCmd(cmd)
     }
 
-    let child = $.spawn(prefix + cmd, {
+    let child = spawn(prefix + cmd, {
       cwd: process.cwd(),
       shell: typeof shell === 'string' ? shell : true,
       stdio: [promise._inheritStdin ? 'inherit' : 'pipe', 'pipe', 'pipe'],
       windowsHide: true,
-      maxBuffer: 200 * 1024 * 1024, // 200 MiB
+      maxBuffer,
     })
 
+    if (timeout) {
+      promise._timeout = setTimeout(() => promise.kill(killSignal), timeout)
+    }
+
     child.on('close', (code, signal) => {
+      promise._timeout && clearTimeout(promise._timeout)
       let message = `${stderr || '\n'}    at ${__from}`
       message += `\n    exit code: ${code}${exitCodeInfo(code) ? ' (' + exitCodeInfo(code) + ')' : ''}`
       if (signal !== null) {

test.mjs

@@ -251,6 +251,20 @@ if (test('Retry works')) {
   assert(Date.now() >= now + 50 * (5 - 1))
 }
 
+if (test('spawn timeout')) {
+  let signal = 0
+  $.spawn.timeout = 100
+  $.spawn.killSignal = 'SIGKILL'
+  try {
+    await $`sleep 9999`
+  } catch (p) {
+    signal = p.signal
+  }
+  delete $.spawn.timeout
+  delete $.spawn.killSignal
+  assert.equal(signal, 'SIGKILL')
+}
+
 let version
 if (test('require() is working in ESM')) {
   let data = require('./package.json')