refactor(tools): migrate to execa (#41062)

For consistency, we should use `execa` for all of our command execution.

Co-authored-by: Claude Sonnet 4.5 <jamie.tanna+github-copilot@mend.io>

Author: jamietanna

tools/mkdocs.ts

@@ -1,5 +1,5 @@
-import type { SpawnSyncReturns } from 'child_process';
 import { Command } from 'commander';
+import type { ExecaSyncReturnValue } from 'execa';
 import fs from 'fs-extra';
 import { logger } from '../lib/logger/index.ts';
 import { generateDocs } from './docs/index.ts';
@@ -68,13 +68,13 @@ async function prepareDocs(opts: any): Promise<void> {
   }
 }
 
-function checkResult(res: SpawnSyncReturns<string>): void {
+function checkResult(res: ExecaSyncReturnValue<string>): void {
   if (res.signal) {
     logger.error(`Signal received: ${res.signal}`);
     process.exit(-1);
-  } else if (res.status && res.status !== 0) {
+  } else if (res.exitCode) {
     logger.error(`Error occured:\n${res.stderr || res.stdout}`);
-    process.exit(res.status);
+    process.exit(res.exitCode);
   } else {
     logger.debug(`Build completed:\n${res.stdout || res.stderr}`);
   }

tools/prepare-deps.mjs

@@ -1,16 +1,24 @@
-import { execSync } from 'child_process';
+import { execaSync } from 'execa';
 
 function testRe2() {
-  execSync(
-    `node -e "try{require('re2')('.*').exec('test')}catch(e){console.error(e);if(e.code === 'ERR_DLOPEN_FAILED' && e.message.includes('NODE_MODULE_VERSION')) process.exit(1); else process.exit(-1)}"`,
+  execaSync(
+    'node',
+    [
+      '-e',
+      `try{require('re2')('.*').exec('test')}catch(e){console.error(e);if(e.code === 'ERR_DLOPEN_FAILED' && e.message.includes('NODE_MODULE_VERSION')) process.exit(1); else process.exit(-1)}`,
+    ],
     { stdio: 'inherit' },
   );
   console.log(`Ok.`);
 }
 
 function testSqlite() {
-  execSync(
-    `node -e "try{new require('better-sqlite3')(':memory:')}catch(e){console.error(e);if(e.code === 'ERR_DLOPEN_FAILED' && e.message.includes('NODE_MODULE_VERSION')) process.exit(1); else process.exit(-1)}"`,
+  execaSync(
+    'node',
+    [
+      '-e',
+      `try{new require('better-sqlite3')(':memory:')}catch(e){console.error(e);if(e.code === 'ERR_DLOPEN_FAILED' && e.message.includes('NODE_MODULE_VERSION')) process.exit(1); else process.exit(-1)}`,
+    ],
     { stdio: 'inherit' },
   );
   console.log(`Ok.`);
@@ -23,9 +31,9 @@ function testSqlite() {
   } catch (e) {
     console.error(`Failed.\n${e}`);
     try {
-      if (e.status === 1) {
+      if (e.exitCode === 1) {
         console.log(`Retry re2 install ...`);
-        execSync('pnpm rb re2', {
+        execaSync('pnpm', ['rb', 're2'], {
           stdio: 'inherit',
         });
         testRe2();
@@ -46,9 +54,9 @@ function testSqlite() {
   } catch (e) {
     console.error(`Failed.\n${e}`);
     try {
-      if (e.status === 1) {
+      if (e.exitCode === 1) {
         console.log(`Retry better-sqlite3 install ...`);
-        execSync('pnpm rb better-sqlite3', {
+        execaSync('pnpm', ['rb', 'better-sqlite3'], {
           stdio: 'inherit',
         });
         testSqlite();

tools/prepare-release.ts

@@ -43,9 +43,9 @@ function build(): void {
   if (res.signal) {
     logger.error(`Signal received: ${res.signal}`);
     process.exit(-1);
-  } else if (res.status && res.status !== 0) {
+  } else if (res.exitCode) {
     logger.error(`Error occured:\n${res.stderr || res.stdout}`);
-    process.exit(res.status);
+    process.exit(res.exitCode);
   } else {
     logger.debug(`Build succeeded:\n${res.stdout || res.stderr}`);
   }

tools/utils/docker.ts

@@ -70,7 +70,7 @@ export async function bake(
     if (result.signal) {
       logger.error(`Signal received: ${result.signal}`);
       process.exit(-1);
-    } else if (result.status && result.status !== 0) {
+    } else if (result.exitCode) {
       if (tries > 0) {
         logger.debug(`Error occured:\n ${result.stderr}`);
         const delay = opts.delay ? toMs(opts.delay) : null;
@@ -81,7 +81,7 @@ export async function bake(
       } else {
         logger.error(`Error occured:\n${result.stderr}`);
         if (opts.exitOnError !== false) {
-          process.exit(result.status);
+          process.exit(result.exitCode);
         }
         return null;
       }
@@ -109,10 +109,10 @@ export function sign(
   if (result.signal) {
     logger.error(`Signal received: ${result.signal}`);
     process.exit(-1);
-  } else if (result.status && result.status !== 0) {
+  } else if (result.exitCode) {
     logger.error(`Error occured:\n${result.stderr}`);
     if (opts.exitOnError !== false) {
-      process.exit(result.status);
+      process.exit(result.exitCode);
     }
   } else {
     logger.debug(`Succeeded:\n${result.stdout || result.stderr}`);

tools/utils/exec.ts

@@ -1,21 +1,21 @@
-import {
-  type SpawnSyncOptions,
-  type SpawnSyncReturns,
-  spawnSync,
-} from 'node:child_process';
+import type { ExecaSyncReturnValue, SyncOptions } from 'execa';
+import { execaSync } from 'execa';
 
 const maxBuffer = 20 * 1024 * 1024;
 
 /**
- * Execute a command
+ * Execute a command synchronously using execa
  * @param {string} cmd
  * @param {string[]} args
  */
 export function exec(
   cmd: string,
   args: string[] = [],
-  opts: SpawnSyncOptions = {},
-): SpawnSyncReturns<string> {
-  // args from shelljs
-  return spawnSync(cmd, args, { ...opts, maxBuffer, encoding: 'utf8' });
+  opts: SyncOptions = {},
+): ExecaSyncReturnValue<string> {
+  return execaSync(cmd, args, {
+    ...opts,
+    maxBuffer,
+    encoding: 'utf8',
+  });
 }