codify-plugin-lib 1.0.29 → 1.0.30

package/dist/utils/utils.d.ts

@@ -12,6 +12,8 @@ type CodifySpawnOptions = {
     cwd?: string;
     stdioString?: boolean;
 } & SpawnOptions;
-export declare function codifySpawn(cmd: string, args?: string[], opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString' | 'shell'>, extras?: Record<any, any>): Promise<SpawnResult>;
+export declare function codifySpawn(cmd: string, args?: string[], opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString'> & {
+    throws?: boolean;
+}, extras?: Record<any, any>): Promise<SpawnResult>;
 export declare function isDebug(): boolean;
 export {};

package/dist/utils/utils.js

@@ -6,7 +6,7 @@ export var SpawnStatus;
 })(SpawnStatus || (SpawnStatus = {}));
 export async function codifySpawn(cmd, args, opts, extras) {
     try {
-        const result = await promiseSpawn(cmd, args ?? [], { ...opts, stdio: 'pipe', stdioString: true, shell: true }, extras);
+        const result = await promiseSpawn(cmd, args ?? [], { ...opts, stdio: 'pipe', stdioString: true, shell: opts?.shell ?? process.env.SHELL }, extras);
         if (isDebug()) {
             console.log(`codifySpawn result for: ${cmd}`);
             console.log(JSON.stringify(result, null, 2));
@@ -19,10 +19,17 @@ export async function codifySpawn(cmd, args, opts, extras) {
             data: status === SpawnStatus.SUCCESS ? result.stdout : result.stderr
         };
     }
-    catch (e) {
+    catch (error) {
+        const shouldThrow = opts?.throws ?? true;
+        if (isDebug() || shouldThrow) {
+            console.error(`CodifySpawn Error for command ${cmd} ${args}`, error);
+        }
+        if (shouldThrow) {
+            throw error;
+        }
         return {
             status: SpawnStatus.ERROR,
-            data: e,
+            data: error,
         };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/utils/utils.ts

@@ -16,17 +16,32 @@ type CodifySpawnOptions = {
   stdioString?: boolean;
 } & SpawnOptions
 
+/**
+ *
+ * @param cmd Command to run. Ex: `rm -rf`
+ * @param args Optional additional arguments to append
+ * @param opts Standard options for node spawn. Additional argument:
+ * throws determines if a shell will throw a JS error. Defaults to true
+ * @param extras From PromiseSpawn
+ *
+ * @see promiseSpawn
+ * @see spawn
+ *
+ * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
+ */
 export async function codifySpawn(
   cmd: string,
   args?: string[],
-  opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString' | 'shell'>,
+  opts?: Omit<CodifySpawnOptions, 'stdio' | 'stdioString'> & { throws?: boolean },
   extras?: Record<any, any>,
 ): Promise<SpawnResult> {
   try {
+    // TODO: Need to benchmark the effects of using sh vs zsh for shell.
+    //  Seems like zsh shells run slower
     const result = await promiseSpawn(
       cmd,
       args ?? [],
-      { ...opts, stdio: 'pipe', stdioString: true, shell: true },
+      { ...opts, stdio: 'pipe', stdioString: true, shell: opts?.shell ?? process.env.SHELL },
       extras,
     );
 
@@ -43,10 +58,19 @@ export async function codifySpawn(
       status,
       data: status === SpawnStatus.SUCCESS ? result.stdout : result.stderr
     }
-  } catch (e) {
+  } catch (error) {
+    const shouldThrow = opts?.throws ?? true;
+    if (isDebug() || shouldThrow) {
+      console.error(`CodifySpawn Error for command ${cmd} ${args}`, error);
+    }
+
+    if (shouldThrow) {
+      throw error;
+    }
+
     return {
       status: SpawnStatus.ERROR,
-      data: e as string,
+      data: error as string,
     }
   }
 }