@magic/cli 0.0.50 → 0.0.51

package/README.md

@@ -572,6 +572,10 @@ update dependencies
 - types: add single to ParseProps
 - update dependencies
 
-##### 0.0.51 - unreleased
+##### 0.0.51
+
+- exec and execFile options are correctly typed
+
+##### 0.0.52 - unreleased
 
 - ...

package/package.json

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

package/src/exec.js

@@ -7,13 +7,12 @@ const libName = '@magic/cli.exec'
 /**
  * Executes a shell command using child_process.exec
  * @param {string} cmd - The shell command to execute.
- * @param {object} [options={}] - Execution options.
- * @param {boolean} [options.stderrToStdout=false] - If true, resolves stderr as stdout instead of rejecting.
+ * @param {child_process.ExecOptionsWithStringEncoding & { stderrToStdout: boolean }} [options = {}] - Execution options.
  * @returns {Promise<string>} Resolves with stdout or stderr (if stderrToStdout = true), rejects with Error.
  */
-export const exec = (cmd, options = {}) =>
+export const exec = (cmd, options) =>
   new Promise((resolve, reject) => {
-    const { stderrToStdout, ...opts } = options
+    const { stderrToStdout = false, ...opts } = options || {}
 
     child_process.exec(cmd, opts, (err, stdout, stderr) => {
       if (err) {

package/src/execFile.js

@@ -8,7 +8,7 @@ const libName = '@magic/cli.execFile'
  * 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 {import('child_process').ExecFileOptions} [opts={}] - Execution options.
+ * @param {child_process.ExecFileOptions} [opts={}] - Execution options.
  * @returns {Promise<string | Buffer>} Resolves with stdout, rejects with Error.
  */
 export const execFile = (p, args = [], opts = {}) =>

package/types/exec.d.ts

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

package/types/execFile.d.ts

@@ -1,5 +1,6 @@
 export function execFile(
   p: string,
   args?: string[],
-  opts?: import('child_process').ExecFileOptions,
+  opts?: child_process.ExecFileOptions,
 ): Promise<string | Buffer>
+import child_process from 'child_process'

package/types/index.d.ts

@@ -12,8 +12,8 @@ export const spawn: (
 ) => import('child_process').ChildProcess
 export const exec: (
   cmd: string,
-  options?: {
-    stderrToStdout?: boolean | undefined
+  options?: import('child_process').ExecOptionsWithStringEncoding & {
+    stderrToStdout: boolean
   },
 ) => Promise<string>
 export const prompt: (