simple-stdout 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Craig Patik
+
+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,16 @@
+# simple-stdout
+
+Run a shell command and get the `stdout` as a string.
+
+## Usage
+
+```sh
+pnpm install simple-stdout
+```
+
+```tsx
+import stdout from 'simple-stdout'
+
+console.log(await stdout('echo "Hello, world!"'))
+// Logs 'Hello, world!'
+```

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns stdout from the given shell command
+ */
+export default function stdout(command: string): Promise<string>;

package/dist/index.js

@@ -0,0 +1,17 @@
+import { exec } from 'node:child_process';
+/**
+ * Returns stdout from the given shell command
+ */
+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
+            }
+        });
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/index.test.d.ts

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

package/dist/index.test.js

@@ -0,0 +1,69 @@
+import { execSync } from 'node:child_process';
+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 result = await stdout('echo "Redirected output" > temp.txt && cat temp.txt');
+        expect(result).toBe('Redirected output');
+        // Clean up
+        execSync('rm temp.txt', { stdio: 'ignore' });
+    });
+    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

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,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,MAAM,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,CAAA;QAElF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAExC,WAAW;QACX,QAAQ,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;IAChD,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"}

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "simple-stdout",
+    "version": "1.0.0",
+    "scripts": {
+        "build": "tsc",
+        "test": "vitest .",
+        "test:once": "vitest run",
+        "format": "prettier --write --list-different .",
+        "check-format": "prettier --check .",
+        "lint": "tsc --noEmit && eslint . --fix && pnpm run format",
+        "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+        "ci": "pnpm build && pnpm check-format && pnpm check-exports",
+        "prepublishOnly": "pnpm run ci",
+        "prepare": "husky"
+    },
+    "type": "module",
+    "main": "./dist/index.js",
+    "files": [
+        "dist"
+    ],
+    "devDependencies": {
+        "@arethetypeswrong/cli": "^0.18.2",
+        "@eslint/js": "^9.28.0",
+        "@types/node": "^22.15.30",
+        "eslint": "^9.28.0",
+        "eslint-config-prettier": "^10.1.5",
+        "eslint-plugin-prettier": "^5.4.1",
+        "husky": "^9.1.7",
+        "prettier": "3.5.3",
+        "tsx": "^4.19.4",
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.33.1",
+        "vitest": "^3.2.3"
+    },
+    "packageManager": "pnpm@10.12.1",
+    "keywords": [],
+    "description": "Get any shell command's stdout as a string",
+    "author": {
+        "name": "Craig Patik",
+        "email": "craig@patik.com",
+        "url": "https://patik.com"
+    },
+    "homepage": "https://github.com/patik/simple-stdout",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/patik/simple-stdout.git"
+    },
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    }
+}