@node-cli/run 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Arno Versini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# Node CLI run command
+
+![npm](https://img.shields.io/npm/v/@node-cli/run?label=version&logo=npm)
+
+> @node-cli/run is a dead-simple script runner for nodejs command-line applications.
+
+## Installation
+
+```sh
+> cd your-project
+> npm install --save-dev @node-cli/run
+```
+
+## Usage
+
+```js
+import { run } from "@node-cli/run";
+const { stdout, stderr } = await run("npm config ls");
+```
+
+## API
+
+**run(command, options) ⇒ `Promise <string>` | `Promise <object>`**
+
+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.
+
+### Arguments
+
+| Argument            | Type    | Default |
+| ------------------- | ------- | ------- |
+| command             | String  | ""      |
+| options             | Object  | { }     |
+| options.ignoreError | Boolean | false   |
+
+### Note
+
+If `ignoreError` is used, the method will not throw but will instead return an object with the keys `exitCode` and `shortMessage`.
+
+#### Examples
+
+```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'"
+);
+```
+
+```js
+import { run } from "@node-cli/run";
+const { exitCode, shortMessage } = await runCommand("ls /not-a-folder", {
+	ignoreError: true,
+});
+// -> exitCode is 1 and shortMessage is "Command failed with exit code 1: ls /not-a-folder"
+```

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 declare const run: (command: string, options?: {
+    ignoreError?: boolean;
+}) => Promise<any>;

package/dist/index.js

@@ -0,0 +1,41 @@
+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  } = {
+        ignoreError: false,
+        ...options
+    };
+    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
+        };
+    } catch (error) {
+        if (ignoreError) {
+            return {
+                exitCode: error.exitCode === undefined ? 1 : error.exitCode,
+                shortMessage: error.shortMessage,
+                stderr: error.exitCode === undefined ? 1 : error.exitCode
+            };
+        } else {
+            throw new Error(kleur.red(error));
+        }
+    }
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@node-cli/run",
+	"version": "0.0.5",
+	"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",
+	"files": [
+		"dist"
+	],
+	"node": ">=16",
+	"dependencies": {
+		"execa": "7.1.1",
+		"kleur": "4.1.5"
+	},
+	"scripts": {
+		"build": "npm-run-all --serial clean build:types build:js",
+		"build:js": "swc --out-dir dist src",
+		"build:types": "tsc",
+		"clean": "rimraf dist types coverage",
+		"lint": "eslint \"src/*.ts\"",
+		"test": "jest",
+		"test:coverage": "npm run test -- --coverage",
+		"watch": "swc --watch --out-dir dist src"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"gitHead": "6e7950590077d5934bf84c676f533696139f8eb9"
+}