simple-stdout 2.0.0 → 2.2.0

package/README.md

@@ -2,15 +2,38 @@
 
 Run a shell command and get the `stdout` as a string.
 
-## Usage
+```javascript
+const name = await stdout('git config --get user.name')
+```
+
+That's it. Just a tiny library with no frills.
+
+## Install
 
 ```sh
-pnpm install simple-stdout
+pnpm add simple-stdout
+
+# or
+yarn add simple-stdout
+
+# or
+npm install simple-stdout
 ```
 
+## Usage
+
 ```javascript
 import stdout from 'simple-stdout'
 
-console.log(await stdout('echo "Hello, world!"'))
-// Logs 'Hello, world!'
+const name = await stdout('git config --get user.name')
+// 'Gérald Genta'
+```
+
+Need `execFile` instead? (Safer for untrusted input, no shell injection worries.)
+
+```javascript
+import { stdoutFile } from 'simple-stdout'
+
+const name = await stdoutFile('git', ['config', '--get', 'user.name'])
+// 'Gérald Genta'
 ```

package/dist/index.d.ts

@@ -1,4 +1,14 @@
+#!/usr/bin/env node
+import type { ExecFileOptions, ExecOptions } from 'node:child_process';
 /**
  * Returns stdout from the given shell command
+ *
+ * Calls `child_process.exec` under the hood.
  */
-export default function stdout(command: string): Promise<string>;
+export default function stdout(command: string, options?: ExecOptions): Promise<string>;
+/**
+ * Returns stdout from executing the given file/executable
+ *
+ * Calls `child_process.execFile` under the hood.
+ */
+export declare function stdoutFile(file: string, args?: readonly string[], options?: ExecFileOptions): Promise<string>;

package/dist/index.js

@@ -1,17 +1,42 @@
-import { exec } from 'node:child_process';
+#!/usr/bin/env node
+import { exec, execFile } from 'node:child_process';
+import { promisify } from 'node:util';
+const asyncExec = promisify(exec);
+/**
+ * Removes trailing newline
+ */
+const cleanOutput = (output) => output.replace(/\n$/, '');
 /**
  * Returns stdout from the given shell command
+ *
+ * Calls `child_process.exec` under the hood.
+ */
+export default async function stdout(command, options) {
+    const { stdout, stderr } = await asyncExec(command, options);
+    if (stderr) {
+        throw new Error(stderr.toString());
+    }
+    if (typeof stdout !== 'string') {
+        return cleanOutput(stdout.toString());
+    }
+    // Remove trailing newline
+    return cleanOutput(stdout);
+}
+const asyncExecFile = promisify(execFile);
+/**
+ * Returns stdout from executing the given file/executable
+ *
+ * Calls `child_process.execFile` under the hood.
  */
-export default async function stdout(command) {
-    return new Promise((resolve, reject) => {
-        exec(command, (err, stdout, stderr) => {
-            if (err || stderr) {
-                reject(err || new Error(stderr));
-            }
-            else if (typeof stdout === 'string') {
-                resolve(stdout.replace(/\n$/, '')); // Remove trailing newline
-            }
-        });
-    });
+export async function stdoutFile(file, args, options) {
+    const { stdout, stderr } = await asyncExecFile(file, args, options);
+    if (stderr) {
+        throw new Error(stderr.toString());
+    }
+    if (typeof stdout !== 'string') {
+        return cleanOutput(stdout.toString());
+    }
+    // Remove trailing newline
+    return cleanOutput(stdout);
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAEzC;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,MAAM,CAAC,OAAe;IAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YAClC,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;gBAChB,MAAM,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;YACpC,CAAC;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA,CAAC,0BAA0B;YACjE,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAErC,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;AAEjC;;GAEG;AACH,MAAM,WAAW,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;AAEzE;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,MAAM,CAAC,OAAe,EAAE,OAAqB;IACvE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAE5D,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,0BAA0B;IAC1B,OAAO,WAAW,CAAC,MAAM,CAAC,CAAA;AAC9B,CAAC;AAED,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;AAEzC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,IAAwB,EAAE,OAAyB;IAC9F,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAEnE,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,0BAA0B;IAC1B,OAAO,WAAW,CAAC,MAAM,CAAC,CAAA;AAC9B,CAAC"}

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "simple-stdout",
-    "version": "2.0.0",
+    "version": "2.2.0",
     "scripts": {
-        "build": "tsc",
+        "build": "tsc -p tsconfig.build.json",
         "test": "vitest .",
         "test:once": "vitest run",
         "format": "prettier --write --list-different .",
@@ -15,6 +15,9 @@
     },
     "type": "module",
     "main": "./dist/index.js",
+    "bin": {
+        "simple-stdout": "./dist/index.js"
+    },
     "files": [
         "dist"
     ],
@@ -28,10 +31,10 @@
         "husky": "^9.1.7",
         "prettier": "3.7.4",
         "typescript": "^5.8.3",
-        "typescript-eslint": "^8.50.1",
+        "typescript-eslint": "^8.52.0",
         "vitest": "^4.0.16"
     },
-    "packageManager": "pnpm@10.26.2",
+    "packageManager": "pnpm@10.27.0",
     "engines": {
         "node": ">=20"
     },

package/dist/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.test.js

@@ -1,73 +0,0 @@
-import { existsSync, unlinkSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { describe, expect, it } from 'vitest';
-import stdout from './index.js';
-describe('stdout()', () => {
-    it('should run a command and return its stdout', async () => {
-        const result = await stdout('echo "Hello, world!"');
-        expect(result).toBe('Hello, world!');
-    });
-    it('should remove trailing newline', async () => {
-        const result = await stdout('echo "No trailing newline"');
-        expect(result).toBe('No trailing newline');
-    });
-    it('should reject on error', async () => {
-        await expect(stdout('nonexistent-command')).rejects.toThrow();
-    });
-    it('should reject on empty command', async () => {
-        await expect(stdout('')).rejects.toThrow();
-    });
-    it('should reject on stderr output', async () => {
-        await expect(stdout('echo "This will cause an error" >&2')).rejects.toThrow();
-    });
-    it('should handle commands with arguments', async () => {
-        const result = await stdout('echo "Argument test"');
-        expect(result).toBe('Argument test');
-    });
-    it('should handle commands with multiple lines', async () => {
-        const result = await stdout('echo "Line 1\nLine 2"');
-        expect(result).toBe('Line 1\nLine 2');
-    });
-    it('should handle commands with special characters', async () => {
-        const result = await stdout('echo "Special characters: !@#$%^&*()"');
-        expect(result).toBe('Special characters: !@#$%^&*()');
-    });
-    it('should handle commands with spaces', async () => {
-        const result = await stdout('echo "Command with spaces"');
-        expect(result).toBe('Command with spaces');
-    });
-    it('should handle commands with quotes', async () => {
-        const result = await stdout('echo "Quoted text"');
-        expect(result).toBe('Quoted text');
-    });
-    it('should handle commands with multiple arguments', async () => {
-        const result = await stdout('echo "Multiple" "Arguments"');
-        expect(result).toBe('Multiple Arguments');
-    });
-    it('should handle commands with environment variables', async () => {
-        const result = await stdout('echo $HOME');
-        expect(result).toBe(process.env.HOME || '');
-    });
-    it('should handle commands with pipes', async () => {
-        const result = await stdout('echo "Piped output" | sed "s/Piped/Modified/"');
-        expect(result).toBe('Modified output');
-    });
-    it('should handle commands with redirection', async () => {
-        const tempFile = join(tmpdir(), `stdout-test-${process.pid}.txt`);
-        const result = await stdout(`echo "Redirected output" > ${tempFile} && cat ${tempFile}`);
-        expect(result).toBe('Redirected output');
-        // Clean up
-        if (existsSync(tempFile))
-            unlinkSync(tempFile);
-    });
-    it('should handle commands with subshells', async () => {
-        const result = await stdout('echo $(echo "Subshell output")');
-        expect(result).toBe('Subshell output');
-    });
-    it('should handle commands with background processes', async () => {
-        const result = await stdout('echo "Background process" & wait');
-        expect(result).toBe('Background process');
-    });
-});
-//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,MAAM,MAAM,YAAY,CAAA;AAE/B,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAA;QAEnD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,4BAA4B,CAAC,CAAA;QAEzD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IACjE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,MAAM,CAAC,MAAM,CAAC,qCAAqC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IACjF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAA;QAEnD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAA;QAEpD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACzC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,uCAAuC,CAAC,CAAA;QAEpE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,4BAA4B,CAAC,CAAA;QAEzD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAA;QAEjD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IACtC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAA;QAE1D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAA;QAEzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,+CAA+C,CAAC,CAAA;QAE5E,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,eAAe,OAAO,CAAC,GAAG,MAAM,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,8BAA8B,QAAQ,WAAW,QAAQ,EAAE,CAAC,CAAA;QAExF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAExC,WAAW;QACX,IAAI,UAAU,CAAC,QAAQ,CAAC;YAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gCAAgC,CAAC,CAAA;QAE7D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,kCAAkC,CAAC,CAAA;QAE/D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}