Add stdioString and stripAnsi options to spawnSync

Author: jdalton

eslint.config.js

@@ -235,7 +235,8 @@ function configs(sourceType) {
           ...js.configs.recommended.languageOptions?.globals,
           ...importFlatConfigs.recommended.languageOptions?.globals,
           ...nodePluginConfigs.languageOptions?.globals,
-          ...nodeGlobalsConfig
+          ...nodeGlobalsConfig,
+          NodeJS: false
         },
         sourceType: isEsm ? 'module' : 'script'
       },

package-lock.json

@@ -2,8 +2,7 @@
 import {
   SpawnOptions as BaseSpawnOptions,
   ChildProcess,
-  IOType,
-  spawnSync as childProcessSpawnSync
+  IOType
 } from 'node:child_process'
 import Stream from 'node:stream'
 
@@ -54,6 +53,22 @@ declare type SpawnOptions = Remap<
     stripAnsi?: boolean | undefined
   }
 >
+declare type SpawnSyncOptions = Omit<SpawnOptions, 'spinner'>
+declare interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions {
+  encoding: NodeJS.BufferEncoding
+}
+declare interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions {
+  encoding?: 'buffer' | null | undefined
+}
+declare interface SpawnSyncReturns<T> {
+  pid: number
+  output: Array<T | null>
+  stdout: T
+  stderr: T
+  status: number | null
+  signal: NodeJS.Signals | null
+  error?: Error | undefined
+}
 declare type StdioType = IOType | 'ipc' | Array<IOType | 'ipc'>
 declare const Spawn: {
   isSpawnError(value: any): value is SpawnError
@@ -70,7 +85,35 @@ declare const Spawn: {
     O extends { stdioString: false } ? Buffer : string,
     typeof extra
   >
-  spawnSync: typeof childProcessSpawnSync
+  spawnSync(command: string): SpawnSyncReturns<Buffer>
+  spawnSync(
+    command: string,
+    options: SpawnSyncOptionsWithStringEncoding
+  ): SpawnSyncReturns<string>
+  spawnSync(
+    command: string,
+    options: SpawnSyncOptionsWithBufferEncoding
+  ): SpawnSyncReturns<Buffer>
+  spawnSync(
+    command: string,
+    options?: SpawnSyncOptions
+  ): SpawnSyncReturns<string | Buffer>
+  spawnSync(command: string, args: readonly string[]): SpawnSyncReturns<Buffer>
+  spawnSync(
+    command: string,
+    args: readonly string[],
+    options: SpawnSyncOptionsWithStringEncoding
+  ): SpawnSyncReturns<string>
+  spawnSync(
+    command: string,
+    args: readonly string[],
+    options: SpawnSyncOptionsWithBufferEncoding
+  ): SpawnSyncReturns<Buffer>
+  spawnSync(
+    command: string,
+    args?: readonly string[],
+    options?: SpawnSyncOptions
+  ): SpawnSyncReturns<string | Buffer>
 }
 declare namespace Spawn {
   export {

registry/lib/spawn.d.ts

@@ -119,8 +119,24 @@ function spawn(cmd, args, options, extra) {
 }
 
 /*@__NO_SIDE_EFFECTS__*/
-function spawnSync(...args) {
-  return getChildProcess().spawnSync(...args)
+function spawnSync(cmd, args, options) {
+  const { stripAnsi: shouldStripAnsi = true, ...spawnOptions } = {
+    __proto__: null,
+    ...options
+  }
+  const { stdioString = true } = spawnOptions
+  const encoding = stdioString ? 'utf8' : 'buffer'
+  const result = getChildProcess().spawnSync(cmd, args, {
+    encoding,
+    ...spawnOptions
+  })
+  if (stdioString) {
+    result.stdout = result.stdout.toString().trim()
+    result.stderr = result.stderr.toString().trim()
+  }
+  return shouldStripAnsi && stdioString
+    ? stripAnsiFromSpawnResult(result)
+    : result
 }
 
 module.exports = {

registry/lib/spawn.js

@@ -629,6 +629,7 @@
     "@socketregistry/is-unicode-supported": "1.0.5",
     "@socketregistry/packageurl-js": "1.0.8",
     "@socketregistry/yocto-spinner": "1.0.20",
+    "@types/node": "24.1.0",
     "@types/pacote": "11.1.8",
     "@yarnpkg/extensions": "2.0.6",
     "ansi-regex": "6.1.0",

registry/package.json

@@ -19,6 +19,7 @@
     "strict": true,
     "strictNullChecks": true,
     "target": "esnext",
+    "types": ["node"],
     "useUnknownInCatchVariables": true,
 
     /* New checks being tried out */