fix: expose kill, ref & unref methods (#11)

* fix: expose kill, ref & unref methods

closes #10

* ci: remove node16

* ci: avoid npx

it's failing in windows

Author: Kikobeats

.github/workflows/pull_request.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: ['16', '18', 'lts/*', 'latest']
+        node-version: ['18', 'lts/*', 'latest']
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -32,7 +32,7 @@ jobs:
       - name: Test
         run: pnpm test
       - name: Report
-        run: npx c8 report --reporter=text-lcov > coverage/lcov.info
+        run: ./node_modules/.bin/c8 report --reporter=text-lcov > coverage/lcov.info
       - name: Coverage
         uses: coverallsapp/github-action@main
         with:
@@ -43,7 +43,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        node-version: ['16', '18', 'lts/*', 'latest']
+        node-version: ['18', 'lts/*', 'latest']
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -61,7 +61,7 @@ jobs:
       - name: Test
         run: pnpm test
       - name: Report
-        run: npx c8 report --reporter=text-lcov > coverage/lcov.info
+        run: ./node_modules/.bin/c8 report --reporter=text-lcov > coverage/lcov.info
       - name: Coverage
         uses: coverallsapp/github-action@main
         with:

package.json

@@ -59,7 +59,7 @@
     "standard-version": "latest"
   },
   "engines": {
-    "node": ">= 16"
+    "node": ">= 18"
   },
   "files": [
     "src"

src/index.js

@@ -3,19 +3,29 @@
 const { spawn } = require('child_process')
 const { EOL } = require('os')
 
-const EE_PROPS = Object.getOwnPropertyNames(require('events').EventEmitter.prototype).filter(name => !name.startsWith('_'))
+const EE_PROPS = Object.getOwnPropertyNames(
+  require('events').EventEmitter.prototype
+)
+  .filter(name => !name.startsWith('_'))
+  .concat(['kill', 'ref', 'unref'])
 
-const eos = (stream, listener, buffer = []) => stream[listener].on('data', data => buffer.push(data)) && buffer
+const eos = (stream, listener, buffer = []) =>
+  stream[listener].on('data', data => buffer.push(data)) && buffer
 
 const clean = str => str.trim().replace(/\n$/, '')
 
-const parse = (buffer, { json } = {}) => (encoding, start, end) => {
-  const data = clean(Buffer.concat(buffer).toString(encoding, start, end))
-  return json ? JSON.parse(data) : data
-}
+const parse =
+  (buffer, { json } = {}) =>
+    (encoding, start, end) => {
+      const data = clean(Buffer.concat(buffer).toString(encoding, start, end))
+      return json ? JSON.parse(data) : data
+    }
 
 const extend = defaults => (input, args, options) => {
-  if (!(args instanceof Array)) { options = args; args = [] }
+  if (!(args instanceof Array)) {
+    options = args
+    args = []
+  }
   const [cmd, ...cmdArgs] = input.split(' ').concat(args).filter(Boolean)
   let childProcess
 
@@ -25,27 +35,36 @@ const extend = defaults => (input, args, options) => {
     const stdout = eos(childProcess, 'stdout')
     const stderr = eos(childProcess, 'stderr')
 
-    childProcess
-      .on('error', reject)
-      .on('exit', code => {
-        Object.defineProperty(childProcess, 'stdout', { get: parse(stdout, opts) })
-        Object.defineProperty(childProcess, 'stderr', { get: parse(stderr) })
-        if (code === 0) return resolve(childProcess)
-        const command = `${cmd} ${cmdArgs.join(' ')}`
-        let message = `The command spawned as:${EOL}${EOL}`
-        message += `  ${command}${EOL}${EOL}`
-        message += `exited with \`{ code: ${code} }\` and the following trace:${EOL}${EOL}`
-        message += String(stderr).split(EOL).map(line => `  ${line}`).join(EOL)
-        const error = new Error(message)
-        error.command = command
-        error.name = 'ChildProcessError'
-        Object.keys(childProcess).forEach(key => { error[key] = childProcess[key] })
-        reject(error)
+    childProcess.on('error', reject).on('exit', code => {
+      Object.defineProperty(childProcess, 'stdout', {
+        get: parse(stdout, opts)
+      })
+      Object.defineProperty(childProcess, 'stderr', { get: parse(stderr) })
+      if (code === 0) return resolve(childProcess)
+      const command = `${cmd} ${cmdArgs.join(' ')}`
+      let message = `The command spawned as:${EOL}${EOL}`
+      message += `  ${command}${EOL}${EOL}`
+      message += `exited with \`{ code: ${code} }\` and the following trace:${EOL}${EOL}`
+      message += String(stderr)
+        .split(EOL)
+        .map(line => `  ${line}`)
+        .join(EOL)
+      const error = new Error(message)
+      error.command = command
+      error.name = 'ChildProcessError'
+      Object.keys(childProcess).forEach(key => {
+        error[key] = childProcess[key]
       })
+      reject(error)
+    })
   })
 
   const subprocess = Object.assign(promise, childProcess)
-  if (childProcess) EE_PROPS.forEach(name => (subprocess[name] = childProcess[name].bind(childProcess)))
+  if (childProcess) {
+    EE_PROPS.forEach(
+      name => (subprocess[name] = childProcess[name].bind(childProcess))
+    )
+  }
   return subprocess
 }
 

test/index.js

@@ -127,6 +127,7 @@ test('piping subprocess', async t => {
 
 test('passing timeout', async t => {
   const result = await $('sleep 3 && echo OK', {
+    shell: true,
     timeout: 1,
     killSignal: 'SIGKILL'
   }).catch(err => err)
@@ -159,3 +160,12 @@ test('event emitter properties are availables', async t => {
     'eventNames'
   ].forEach(name => t.truthy(subprocess[name]))
 })
+
+test('child process properties are available', async t => {
+  const subprocess = $('echo 1234567890')
+  await new Promise(resolve => subprocess.once('spawn', resolve))
+  const result = await subprocess
+  t.is(result.stdout, '1234567890')
+  t.is(result.exitCode, 0)
+  ;['kill', 'ref', 'unref'].forEach(name => t.truthy(subprocess[name]))
+})