@node-cli/run 1.0.5 → 1.1.0

package/README.md

@@ -26,11 +26,12 @@ Runs a shell command asynchronously and returns both `stdout` and `stderr`. If t
 
 ### Arguments
 
-| Argument            | Type    | Default |
-| ------------------- | ------- | ------- |
-| command             | String  | ""      |
-| options             | Object  | { }     |
-| options.ignoreError | Boolean | false   |
+| Argument             | Type    | Default |
+| -------------------- | ------- | ------- |
+| command              | String  | ""      |
+| options              | Object  | { }     |
+| options.ignoreError  | Boolean | false   |
+| options.streamOutput | Boolean | false   |
 
 ### Note
 
@@ -38,18 +39,37 @@ If `ignoreError` is used, the method will not throw but will instead return an o
 
 #### Examples
 
+##### Basic usage
+
+```js
+import { run } from "@node-cli/run";
+const { stdout, stderr } = await run("npm run build");
+```
+
+##### Multiple commands
+
 ```js
 import { run } from "@node-cli/run";
-const { stdout, stderr } = await run("npm config ls");
 const { stdout, stderr } = await run(
-	"git add -A && git commit -a -m 'First commit'"
+  "git add -A && git commit -a -m 'First commit'"
 );
 ```
 
+##### Stream output
+
+```js
+import { run } from "@node-cli/run";
+await run("npm run build", {
+  streamOutput: true
+});
+```
+
+##### Ignore error
+
 ```js
 import { run } from "@node-cli/run";
 const { exitCode, shortMessage } = await runCommand("ls /not-a-folder", {
-	ignoreError: true,
+  ignoreError: true
 });
 // -> exitCode is 1 and shortMessage is "Command failed with exit code 1: ls /not-a-folder"
 ```

package/dist/index.d.ts

@@ -3,3 +3,4 @@
  */
 
 export * from "./run";
+export * from "./utilities";

package/dist/run.d.ts

@@ -13,6 +13,8 @@ export type RunResult = {
     exitCode?: number;
     shortMessage?: string;
 };
-export declare const run: (command: string, options?: {
+export type RunOptions = {
     ignoreError?: boolean;
-}) => Promise<RunResult>;
+    streamOutput?: boolean;
+};
+export declare const run: (command: string, options?: RunOptions) => Promise<RunResult>;

package/dist/run.js

@@ -1,24 +1,39 @@
-import { execaCommand } from "execa";
+import { execa, execaCommand } from "execa";
 import kleur from "kleur";
+import { parseCommandString } from "./utilities.js";
 export const run = async (command, options)=>{
     const { ignoreError } = {
         ignoreError: false,
         ...options
     };
+    const execaOptions = {
+        shell: false,
+        preferLocal: true
+    };
+    if (command.includes("&&") || command.includes("&") || command.includes("||") || command.includes("|")) {
+        execaOptions.shell = true;
+    }
+    /* istanbul ignore next */ if (options?.streamOutput) {
+        execaOptions.stdout = [
+            "pipe",
+            "inherit"
+        ];
+    }
     try {
-        const { stdout, stderr } = await execaCommand(command, {
-            /**
-			 * For some reason, a command with a " or ' in execa.command() will
-			 * fail, but it works if shell is set to true... It would work if
-			 * the execaCommand() API is not used:
-			 * execa("ls", ["-l", "|", "wc"]);
-			 * Same problems with &, &&, | and ||.
-			 */ shell: command.includes('"') || command.includes("'") || command.includes("&&") || command.includes("&") || command.includes("||") || command.includes("|")
-        });
-        return {
-            stderr,
-            stdout
-        };
+        if (execaOptions.shell) {
+            const { stdout, stderr } = await execaCommand(command, execaOptions);
+            return {
+                stderr,
+                stdout
+            };
+        } else {
+            const commandArray = parseCommandString(command);
+            const { stdout, stderr } = await execa(commandArray[0], commandArray.slice(1), execaOptions);
+            return {
+                stderr,
+                stdout
+            };
+        }
     } catch (error) {
         if (ignoreError) {
             return {

package/dist/run.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/run.ts"],"sourcesContent":["import { execaCommand } from \"execa\";\nimport kleur from \"kleur\";\n\n/**\n * Runs a shell command asynchronously and\n * returns both `stdout` and `stderr`.\n * If the command fails to run (invalid command or the commands status is\n * anything but 0), the call will throw an exception. The exception can be\n * ignored if the `options.ignoreError` flag is true.\n *\n * @async\n */\nexport type RunResult = {\n\tstderr?: string | number;\n\tstdout?: string | number;\n\texitCode?: number;\n\tshortMessage?: string;\n};\nexport const run = async (\n\tcommand: string,\n\toptions?: { ignoreError?: boolean },\n): Promise<RunResult> => {\n\tconst { ignoreError } = {\n\t\tignoreError: false,\n\t\t...options,\n\t};\n\ttry {\n\t\tconst { stdout, stderr } = await execaCommand(command, {\n\t\t\t/**\n\t\t\t * For some reason, a command with a \" or ' in execa.command() will\n\t\t\t * fail, but it works if shell is set to true... It would work if\n\t\t\t * the execaCommand() API is not used:\n\t\t\t * execa(\"ls\", [\"-l\", \"|\", \"wc\"]);\n\t\t\t * Same problems with &, &&, | and ||.\n\t\t\t */\n\t\t\tshell:\n\t\t\t\tcommand.includes('\"') ||\n\t\t\t\tcommand.includes(\"'\") ||\n\t\t\t\tcommand.includes(\"&&\") ||\n\t\t\t\tcommand.includes(\"&\") ||\n\t\t\t\tcommand.includes(\"||\") ||\n\t\t\t\tcommand.includes(\"|\"),\n\t\t});\n\n\t\treturn { stderr, stdout };\n\t} catch (error) {\n\t\tif (ignoreError) {\n\t\t\treturn {\n\t\t\t\texitCode: error.exitCode === undefined ? 1 : error.exitCode,\n\t\t\t\tshortMessage: error.shortMessage,\n\t\t\t\tstderr: error.exitCode === undefined ? 1 : error.exitCode,\n\t\t\t};\n\t\t} else {\n\t\t\tthrow new Error(kleur.red(error));\n\t\t}\n\t}\n};\n"],"names":["execaCommand","kleur","run","command","options","ignoreError","stdout","stderr","shell","includes","error","exitCode","undefined","shortMessage","Error","red"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,YAAY,QAAQ,QAAQ;AACrC,OAAOC,WAAW,QAAQ;AAiB1B,OAAO,MAAMC,MAAM,OAClBC,SACAC;IAEA,MAAM,EAAEC,WAAW,EAAE,GAAG;QACvBA,aAAa;QACb,GAAGD,OAAO;IACX;IACA,IAAI;QACH,MAAM,EAAEE,MAAM,EAAEC,MAAM,EAAE,GAAG,MAAMP,aAAaG,SAAS;YACtD;;;;;;IAMC,GACDK,OACCL,QAAQM,QAAQ,CAAC,QACjBN,QAAQM,QAAQ,CAAC,QACjBN,QAAQM,QAAQ,CAAC,SACjBN,QAAQM,QAAQ,CAAC,QACjBN,QAAQM,QAAQ,CAAC,SACjBN,QAAQM,QAAQ,CAAC;QACnB;QAEA,OAAO;YAAEF;YAAQD;QAAO;IACzB,EAAE,OAAOI,OAAO;QACf,IAAIL,aAAa;YAChB,OAAO;gBACNM,UAAUD,MAAMC,QAAQ,KAAKC,YAAY,IAAIF,MAAMC,QAAQ;gBAC3DE,cAAcH,MAAMG,YAAY;gBAChCN,QAAQG,MAAMC,QAAQ,KAAKC,YAAY,IAAIF,MAAMC,QAAQ;YAC1D;QACD,OAAO;YACN,MAAM,IAAIG,MAAMb,MAAMc,GAAG,CAACL;QAC3B;IACD;AACD,EAAE"}
+{"version":3,"sources":["../src/run.ts"],"sourcesContent":["import { execa, execaCommand } from \"execa\";\nimport kleur from \"kleur\";\nimport { parseCommandString } from \"./utilities.js\";\n\n/**\n * Runs a shell command asynchronously and\n * returns both `stdout` and `stderr`.\n * If the command fails to run (invalid command or the commands status is\n * anything but 0), the call will throw an exception. The exception can be\n * ignored if the `options.ignoreError` flag is true.\n *\n * @async\n */\nexport type RunResult = {\n\tstderr?: string | number;\n\tstdout?: string | number;\n\texitCode?: number;\n\tshortMessage?: string;\n};\nexport type RunOptions = {\n\tignoreError?: boolean;\n\tstreamOutput?: boolean;\n};\ntype ExecaOptions = {\n\tpreferLocal: boolean;\n\tshell: boolean;\n\tstdout?: [\"pipe\", \"inherit\"];\n};\n\nexport const run = async (\n\tcommand: string,\n\toptions?: RunOptions,\n): Promise<RunResult> => {\n\tconst { ignoreError } = {\n\t\tignoreError: false,\n\t\t...options,\n\t};\n\tconst execaOptions: ExecaOptions = {\n\t\tshell: false,\n\t\tpreferLocal: true,\n\t};\n\n\tif (\n\t\tcommand.includes(\"&&\") ||\n\t\tcommand.includes(\"&\") ||\n\t\tcommand.includes(\"||\") ||\n\t\tcommand.includes(\"|\")\n\t) {\n\t\texecaOptions.shell = true;\n\t}\n\n\t/* istanbul ignore next */\n\tif (options?.streamOutput) {\n\t\texecaOptions.stdout = [\"pipe\", \"inherit\"];\n\t}\n\n\ttry {\n\t\tif (execaOptions.shell) {\n\t\t\tconst { stdout, stderr } = await execaCommand(command, execaOptions);\n\t\t\treturn { stderr, stdout };\n\t\t} else {\n\t\t\tconst commandArray = parseCommandString(command);\n\t\t\tconst { stdout, stderr } = await execa(\n\t\t\t\tcommandArray[0],\n\t\t\t\tcommandArray.slice(1),\n\t\t\t\texecaOptions,\n\t\t\t);\n\t\t\treturn { stderr, stdout };\n\t\t}\n\t} catch (error) {\n\t\tif (ignoreError) {\n\t\t\treturn {\n\t\t\t\texitCode: error.exitCode === undefined ? 1 : error.exitCode,\n\t\t\t\tshortMessage: error.shortMessage,\n\t\t\t\tstderr: error.exitCode === undefined ? 1 : error.exitCode,\n\t\t\t};\n\t\t} else {\n\t\t\tthrow new Error(kleur.red(error));\n\t\t}\n\t}\n};\n"],"names":["execa","execaCommand","kleur","parseCommandString","run","command","options","ignoreError","execaOptions","shell","preferLocal","includes","streamOutput","stdout","stderr","commandArray","slice","error","exitCode","undefined","shortMessage","Error","red"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,KAAK,EAAEC,YAAY,QAAQ,QAAQ;AAC5C,OAAOC,WAAW,QAAQ;AAC1B,SAASC,kBAAkB,QAAQ,iBAAiB;AA2BpD,OAAO,MAAMC,MAAM,OAClBC,SACAC;IAEA,MAAM,EAAEC,WAAW,EAAE,GAAG;QACvBA,aAAa;QACb,GAAGD,OAAO;IACX;IACA,MAAME,eAA6B;QAClCC,OAAO;QACPC,aAAa;IACd;IAEA,IACCL,QAAQM,QAAQ,CAAC,SACjBN,QAAQM,QAAQ,CAAC,QACjBN,QAAQM,QAAQ,CAAC,SACjBN,QAAQM,QAAQ,CAAC,MAChB;QACDH,aAAaC,KAAK,GAAG;IACtB;IAEA,wBAAwB,GACxB,IAAIH,SAASM,cAAc;QAC1BJ,aAAaK,MAAM,GAAG;YAAC;YAAQ;SAAU;IAC1C;IAEA,IAAI;QACH,IAAIL,aAAaC,KAAK,EAAE;YACvB,MAAM,EAAEI,MAAM,EAAEC,MAAM,EAAE,GAAG,MAAMb,aAAaI,SAASG;YACvD,OAAO;gBAAEM;gBAAQD;YAAO;QACzB,OAAO;YACN,MAAME,eAAeZ,mBAAmBE;YACxC,MAAM,EAAEQ,MAAM,EAAEC,MAAM,EAAE,GAAG,MAAMd,MAChCe,YAAY,CAAC,EAAE,EACfA,aAAaC,KAAK,CAAC,IACnBR;YAED,OAAO;gBAAEM;gBAAQD;YAAO;QACzB;IACD,EAAE,OAAOI,OAAO;QACf,IAAIV,aAAa;YAChB,OAAO;gBACNW,UAAUD,MAAMC,QAAQ,KAAKC,YAAY,IAAIF,MAAMC,QAAQ;gBAC3DE,cAAcH,MAAMG,YAAY;gBAChCN,QAAQG,MAAMC,QAAQ,KAAKC,YAAY,IAAIF,MAAMC,QAAQ;YAC1D;QACD,OAAO;YACN,MAAM,IAAIG,MAAMnB,MAAMoB,GAAG,CAACL;QAC3B;IACD;AACD,EAAE"}

package/dist/utilities.d.ts

@@ -0,0 +1 @@
+export declare const parseCommandString: (command: string) => any[];

package/dist/utilities.js

@@ -0,0 +1,21 @@
+const SPACES_REGEXP = / +/g;
+export const parseCommandString = (command)=>{
+    const trimmedCommand = command.trim();
+    if (trimmedCommand === "") {
+        return [];
+    }
+    const tokens = [];
+    for (const token of trimmedCommand.split(SPACES_REGEXP)){
+        // Allow spaces to be escaped by a backslash if not meant as a delimiter
+        const previousToken = tokens.at(-1);
+        /* istanbul ignore next */ if (previousToken && previousToken.endsWith("\\")) {
+            // Merge previous token with current one
+            tokens[tokens.length - 1] = `${previousToken.slice(0, -1)} ${token}`;
+        } else {
+            tokens.push(token);
+        }
+    }
+    return tokens;
+};
+
+//# sourceMappingURL=utilities.js.map

package/dist/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utilities.ts"],"sourcesContent":["const SPACES_REGEXP = / +/g;\n\nexport const parseCommandString = (command: string) => {\n\tconst trimmedCommand = command.trim();\n\tif (trimmedCommand === \"\") {\n\t\treturn [];\n\t}\n\tconst tokens = [];\n\tfor (const token of trimmedCommand.split(SPACES_REGEXP)) {\n\t\t// Allow spaces to be escaped by a backslash if not meant as a delimiter\n\t\tconst previousToken = tokens.at(-1);\n\t\t/* istanbul ignore next */\n\t\tif (previousToken && previousToken.endsWith(\"\\\\\")) {\n\t\t\t// Merge previous token with current one\n\t\t\ttokens[tokens.length - 1] = `${previousToken.slice(0, -1)} ${token}`;\n\t\t} else {\n\t\t\ttokens.push(token);\n\t\t}\n\t}\n\treturn tokens;\n};\n"],"names":["SPACES_REGEXP","parseCommandString","command","trimmedCommand","trim","tokens","token","split","previousToken","at","endsWith","length","slice","push"],"rangeMappings":";;;;;;;;;;;;;;;;;;","mappings":"AAAA,MAAMA,gBAAgB;AAEtB,OAAO,MAAMC,qBAAqB,CAACC;IAClC,MAAMC,iBAAiBD,QAAQE,IAAI;IACnC,IAAID,mBAAmB,IAAI;QAC1B,OAAO,EAAE;IACV;IACA,MAAME,SAAS,EAAE;IACjB,KAAK,MAAMC,SAASH,eAAeI,KAAK,CAACP,eAAgB;QACxD,wEAAwE;QACxE,MAAMQ,gBAAgBH,OAAOI,EAAE,CAAC,CAAC;QACjC,wBAAwB,GACxB,IAAID,iBAAiBA,cAAcE,QAAQ,CAAC,OAAO;YAClD,wCAAwC;YACxCL,MAAM,CAACA,OAAOM,MAAM,GAAG,EAAE,GAAG,CAAC,EAAEH,cAAcI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAEN,MAAM,CAAC;QACrE,OAAO;YACND,OAAOQ,IAAI,CAACP;QACb;IACD;IACA,OAAOD;AACR,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/run",
-	"version": "1.0.5",
+	"version": "1.1.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A wrapper for child_process for nodejs CLI apps",
@@ -24,10 +24,12 @@
 		"lint": "biome lint src",
 		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules jest",
 		"test:coverage": "npm run test -- --coverage",
+		"test:echo": "echo \"testing testing\"",
+		"test:watch": "npm run test -- --watch",
 		"watch": "swc --strip-leading-paths --watch --out-dir dist src"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "e511453b89f180c52ca60e10bd1dfb3c8675cbec"
+	"gitHead": "c7a00537e6b35ea13ccbab724b30f45ad0e6a822"
 }