Replace child_process.exec() with execFile() (#288)

Author: mikeharder

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.11.0
+
+- Breaking Change: Replace export `childProcess.exec()` with `childProcess.execFile()`
+
 ## 0.10.5
 
 - Bump `glob` from `^12.0.0` to `^13.0.0`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/avocado",
-  "version": "0.10.5",
+  "version": "0.11.0",
   "description": "A validator of OpenAPI configurations",
   "type": "module",
   "main": "dist/index.js",

src/child-process.ts

@@ -4,7 +4,7 @@
 import * as childProcess from 'child_process'
 import * as util from 'util'
 
-const nodeJsExec = util.promisify(childProcess.exec)
+const nodeJsExecFile = util.promisify(childProcess.execFile)
 
 export type ExecResult = {
   /**
@@ -17,5 +17,8 @@ export type ExecResult = {
   readonly stderr: string
 }
 
-export const exec = (command: string, options: childProcess.ExecOptionsWithStringEncoding): Promise<ExecResult> =>
-  nodeJsExec(command, { maxBuffer: Infinity, ...options })
+export const execFile = (
+  file: string,
+  args: readonly string[],
+  options: childProcess.ExecFileOptionsWithStringEncoding,
+): Promise<ExecResult> => nodeJsExecFile(file, args, { maxBuffer: Infinity, ...options })

src/git.ts

@@ -34,5 +34,5 @@ export const repository =
         GIT_TERMINAL_PROMPT: '0',
       },
     }
-    return childProcess.exec(`git ${cmd} ${args.join(' ')}`, options)
+    return childProcess.execFile('git', [cmd, ...args], options)
   }

src/test/child-process-test.ts

@@ -7,10 +7,11 @@ import { childProcess } from '../index.js'
 import { generate } from './generate-stdout.js'
 
 describe('child-process', () => {
-  it('exec maxBuffer', async () => {
+  it('execFile maxBuffer', async () => {
     // call `generate-stdout.print()` as a separate process.
-    const { stdout } = await childProcess.exec(
-      'node -e "import { print } from \'./dist/test/generate-stdout.js\'; print();"',
+    const { stdout } = await childProcess.execFile(
+      'node',
+      ['-e', "import { print } from './dist/test/generate-stdout.js'; print();"],
       {},
     )
     const expected = generate()