@magic/cli 0.0.51 → 0.0.53

package/README.md

@@ -576,6 +576,14 @@ update dependencies
 
 - exec and execFile options are correctly typed
 
-##### 0.0.52 - unreleased
+##### 0.0.52
+
+- actually publish the types from 0.0.51.
+
+##### 0.0.53
+
+- export exec, execFile and spawn option types
+
+##### 0.0.54 - unreleased
 
 - ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/cli",
-  "version": "0.0.51",
+  "version": "0.0.53",
   "homepage": "https://magic.github.io/cli",
   "description": "declarative command line interfaces with aliasing, commands and environment sanitization",
   "scripts": {

package/src/exec.js

@@ -4,10 +4,12 @@ import error from '@magic/error'
 
 const libName = '@magic/cli.exec'
 
+/** @typedef {child_process.ExecOptionsWithStringEncoding & { stderrToStdout?: boolean }} CLIExecOptions  */
+
 /**
  * Executes a shell command using child_process.exec
  * @param {string} cmd - The shell command to execute.
- * @param {child_process.ExecOptionsWithStringEncoding & { stderrToStdout: boolean }} [options = {}] - Execution options.
+ * @param {CLIExecOptions} [options = {}] - Execution options.
  * @returns {Promise<string>} Resolves with stdout or stderr (if stderrToStdout = true), rejects with Error.
  */
 export const exec = (cmd, options) =>

package/src/execFile.js

@@ -4,15 +4,18 @@ import error from '@magic/error'
 
 const libName = '@magic/cli.execFile'
 
+/** @typedef {child_process.ExecFileOptions & { stderrToStdout?: boolean }} CLIExecFileOptions  */
+
 /**
  * Executes a file using child_process.execFile
  * @param {string} p - Path to the executable file.
  * @param {string[]} [args=[]] - Arguments to pass to the executable.
- * @param {child_process.ExecFileOptions} [opts={}] - Execution options.
+ * @param {CLIExecFileOptions} [options={}] - Execution options.
  * @returns {Promise<string | Buffer>} Resolves with stdout, rejects with Error.
  */
-export const execFile = (p, args = [], opts = {}) =>
+export const execFile = (p, args = [], options = {}) =>
   new Promise((resolve, reject) => {
+    const { stderrToStdout = false, ...opts } = options
     child_process.execFile(
       p,
       args.filter(a => a),
@@ -23,10 +26,16 @@ export const execFile = (p, args = [], opts = {}) =>
           reject(err)
           return
         }
+
         if (stderr) {
-          const e = error(new Error(`${libName}: error: ${stderr}`), 'E_EXECFILE_STDERR')
-          reject(e)
-          return
+          if (stderrToStdout) {
+            resolve(stderr)
+            return
+          } else {
+            const e = error(new Error(`${libName}: error: ${stderr}`), 'E_EXECFILE_STDERR')
+            reject(e)
+            return
+          }
         }
 
         resolve(stdout)

package/src/index.js

@@ -73,4 +73,8 @@ cli.prompt = promptUser
 export const execFile = executeFile
 cli.execFile = executeFile
 
+/** @typedef {import('./execFile.js').CLIExecFileOptions} CLIExecFileOptions */
+/** @typedef {import('./exec.js').CLIExecOptions} CLIExecOptions */
+/** @typedef {import('./spawn.js')} CLISpawnOptions*/
+
 export default cli

package/src/spawn.js

@@ -1,19 +1,21 @@
 import child_process from 'child_process'
 
+/** @typedef {import('child_process').SpawnOptions} CLISpawnOptions*/
+
 /**
  * Spawns a new process.
  * @param {string} cmd - Command to run.
  * @param {string[]} [args=[]] - Arguments for the command.
- * @param {import('child_process').SpawnOptions} [opt={}] - Spawn options.
+ * @param {CLISpawnOptions} [options={}] - Spawn options.
  * @returns {import('child_process').ChildProcess} The spawned process.
  */
-export const spawn = (cmd, args = [], opt = {}) => {
-  /** @type {import('child_process').SpawnOptions} */
+export const spawn = (cmd, args = [], options = {}) => {
+  /** @type {CLISpawnOptions} */
   const opts = {
     cwd: process.cwd(),
     env: process.env,
     stdio: 'inherit',
-    ...opt,
+    ...options,
   }
 
   return child_process.spawn(cmd, args, opts)

package/types/exec.d.ts

@@ -1,7 +1,5 @@
-export function exec(
-  cmd: string,
-  options?: child_process.ExecOptionsWithStringEncoding & {
-    stderrToStdout: boolean
-  },
-): Promise<string>
+export function exec(cmd: string, options?: CLIExecOptions): Promise<string>
+export type CLIExecOptions = child_process.ExecOptionsWithStringEncoding & {
+  stderrToStdout?: boolean
+}
 import child_process from 'child_process'

package/types/execFile.d.ts

@@ -1,6 +1,9 @@
 export function execFile(
   p: string,
   args?: string[],
-  opts?: child_process.ExecFileOptions,
+  options?: CLIExecFileOptions,
 ): Promise<string | Buffer>
+export type CLIExecFileOptions = child_process.ExecFileOptions & {
+  stderrToStdout?: boolean
+}
 import child_process from 'child_process'

package/types/index.d.ts

@@ -8,14 +8,9 @@ export namespace cli {
 export const spawn: (
   cmd: string,
   args?: string[],
-  opt?: import('child_process').SpawnOptions,
+  options?: import('./spawn.js').CLISpawnOptions,
 ) => import('child_process').ChildProcess
-export const exec: (
-  cmd: string,
-  options?: import('child_process').ExecOptionsWithStringEncoding & {
-    stderrToStdout: boolean
-  },
-) => Promise<string>
+export const exec: (cmd: string, options?: import('./exec.js').CLIExecOptions) => Promise<string>
 export const prompt: (
   msg?: string | string[],
   options?: {
@@ -27,7 +22,7 @@ export const prompt: (
 export const execFile: (
   p: string,
   args?: string[],
-  opts?: import('child_process').ExecFileOptions,
+  options?: import('./execFile.js').CLIExecFileOptions,
 ) => Promise<string | Buffer>
 export default cli
 export type ParseProps = {
@@ -52,6 +47,9 @@ export type ParsedCLI = {
   commands: Record<string, boolean>
   errors: Array<string | string[]>
 }
+export type CLIExecFileOptions = import('./execFile.js').CLIExecFileOptions
+export type CLIExecOptions = import('./exec.js').CLIExecOptions
+export type CLISpawnOptions = typeof import('./spawn.js')
 import { spawn as spawner } from './spawn.js'
 import { exec as execute } from './exec.js'
 import { prompt as promptUser } from './prompt.js'

package/types/spawn.d.ts

@@ -1,5 +1,6 @@
 export function spawn(
   cmd: string,
   args?: string[],
-  opt?: import('child_process').SpawnOptions,
+  options?: CLISpawnOptions,
 ): import('child_process').ChildProcess
+export type CLISpawnOptions = import('child_process').SpawnOptions