@node-cli/run 1.0.0 → 1.0.2

package/README.md

@@ -53,3 +53,7 @@ const { exitCode, shortMessage } = await runCommand("ls /not-a-folder", {
 });
 // -> exitCode is 1 and shortMessage is "Command failed with exit code 1: ls /not-a-folder"
 ```
+
+## License
+
+MIT © Arno Versini

package/dist/index.d.ts

@@ -2,4 +2,4 @@
  * @file Automatically generated by barrelsby.
  */
 
-export * from "./index";
+export * from "./run";

package/dist/run.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Runs a shell command asynchronously and
+ * returns both `stdout` and `stderr`.
+ * If the command fails to run (invalid command or the commands status is
+ * anything but 0), the call will throw an exception. The exception can be
+ * ignored if the `options.ignoreError` flag is true.
+ *
+ * @async
+ */
+export type RunResult = {
+    stderr?: string | number;
+    stdout?: string | number;
+    exitCode?: number;
+    shortMessage?: string;
+};
+export declare const run: (command: string, options?: {
+    ignoreError?: boolean;
+}) => Promise<RunResult>;

package/dist/{index.js → run.js}

@@ -1,20 +1,12 @@
 import { execaCommand } from "execa";
 import kleur from "kleur";
-/**
- * Runs a shell command asynchronously and
- * returns both `stdout` and `stderr`.
- * If the command fails to run (invalid command or the commands status is
- * anything but 0), the call will throw an exception. The exception can be
- * ignored if the `options.ignoreError` flag is true.
- *
- * @async
- */ export const run = async (command, options)=>{
-    const { ignoreError  } = {
+export const run = async (command, options)=>{
+    const { ignoreError } = {
         ignoreError: false,
         ...options
     };
     try {
-        const { stdout , stderr  } = await execaCommand(command, {
+        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
@@ -40,4 +32,4 @@ import kleur from "kleur";
     }
 };
 
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=run.js.map

package/dist/run.js.map

@@ -0,0 +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"],"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"}

package/package.json

@@ -1,18 +1,18 @@
 {
 	"name": "@node-cli/run",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A wrapper for child_process for nodejs CLI apps",
 	"type": "module",
 	"types": "./dist/index.d.ts",
-	"exports": "./dist/index.js",
+	"exports": "./dist/run.js",
 	"files": [
 		"dist"
 	],
 	"node": ">=16",
 	"dependencies": {
-		"execa": "7.1.1",
+		"execa": "8.0.1",
 		"kleur": "4.1.5"
 	},
 	"scripts": {
@@ -21,7 +21,7 @@
 		"build:js": "swc --source-maps --out-dir dist src",
 		"build:types": "tsc",
 		"clean": "rimraf dist types coverage",
-		"lint": "eslint \"src/*.ts\"",
+		"lint": "prettier --write \"src/*.ts\" && eslint --fix \"src/*.ts\"",
 		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules jest",
 		"test:coverage": "npm run test -- --coverage",
 		"watch": "swc --watch --out-dir dist src"
@@ -29,5 +29,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "fe6401830d153ab91166243c2cafd96f6cc0d9b5"
+	"gitHead": "14e79a79e03610f47ab1269076315f183d8a3a0e"
 }

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.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 const run = async (\n\tcommand: string,\n\toptions?: { ignoreError?: boolean }\n): Promise<any> => {\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"],"mappings":"AAAA,SAASA,YAAY,QAAQ,QAAQ;AACrC,OAAOC,WAAW,QAAQ;AAE1B;;;;;;;;CAQC,GACD,OAAO,MAAMC,MAAM,OAClBC,SACAC,UACkB;IAClB,MAAM,EAAEC,YAAW,EAAE,GAAG;QACvBA,aAAa,KAAK;QAClB,GAAGD,OAAO;IACX;IACA,IAAI;QACH,MAAM,EAAEE,OAAM,EAAEC,OAAM,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,QAAQ;QACnC,CAAC;IACF;AACD,EAAE"}