command-stream 0.0.2 → 0.0.4

package/$.mjs

@@ -5,6 +5,9 @@
 // 3. EventEmitter: $`command`.on('data', chunk => ...).on('end', result => ...)
 // 4. Stream access: $`command`.stdout, $`command`.stderr
 
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+
 const isBun = typeof globalThis.Bun !== 'undefined';
 
 // Global shell settings (like bash set -e / set +e)
@@ -16,6 +19,20 @@ let globalShellSettings = {
   nounset: false     // set -u equivalent: error on undefined variables
 };
 
+// Helper function to create result objects with Bun.$ compatibility
+function createResult({ code, stdout = '', stderr = '', stdin = '' }) {
+  return {
+    code,
+    stdout,
+    stderr,
+    stdin,
+    // Bun.$ compatibility method
+    async text() {
+      return stdout;
+    }
+  };
+}
+
 // Virtual command registry - unified system for all commands
 const virtualCommands = new Map();
 
@@ -219,13 +236,21 @@ class ProcessRunner extends StreamEmitter {
     const code = await exited;
     await Promise.all([outPump, errPump, stdinPumpPromise]);
 
-    this.result = {
+    const resultData = {
       code,
       stdout: this.options.capture ? Buffer.concat(this.outChunks).toString('utf8') : undefined,
       stderr: this.options.capture ? Buffer.concat(this.errChunks).toString('utf8') : undefined,
       stdin: this.options.capture && this.inChunks ? Buffer.concat(this.inChunks).toString('utf8') : undefined,
       child: this.child
     };
+    
+    this.result = {
+      ...resultData,
+      // Bun.$ compatibility method
+      async text() {
+        return resultData.stdout || '';
+      }
+    };
 
     this.finished = true;
     this.emit('end', this.result);
@@ -481,7 +506,7 @@ class ProcessRunner extends StreamEmitter {
 
   async _runPipeline(commands) {
     if (commands.length === 0) {
-      return { code: 1, stdout: '', stderr: 'No commands in pipeline', stdin: '' };
+      return createResult({ code: 1, stdout: '', stderr: 'No commands in pipeline', stdin: '' });
     }
 
     let currentOutput = '';
@@ -565,14 +590,14 @@ class ProcessRunner extends StreamEmitter {
               this.emit('data', { type: 'stderr', data: buf });
             }
             
-            // Store final result
-            const finalResult = {
+            // Store final result using createResult helper for .text() method compatibility
+            const finalResult = createResult({
               code: result.code,
               stdout: currentOutput,
               stderr: result.stderr,
               stdin: this.options.stdin && typeof this.options.stdin === 'string' ? this.options.stdin : 
                      this.options.stdin && Buffer.isBuffer(this.options.stdin) ? this.options.stdin.toString('utf8') : ''
-            };
+            });
             
             this.result = finalResult;
             this.finished = true;
@@ -605,13 +630,13 @@ class ProcessRunner extends StreamEmitter {
           }
         } catch (error) {
           // Handle errors from virtual commands in pipeline
-          const result = {
+          const result = createResult({
             code: error.code ?? 1,
             stdout: currentOutput,
             stderr: error.stderr ?? error.message,
             stdin: this.options.stdin && typeof this.options.stdin === 'string' ? this.options.stdin : 
                    this.options.stdin && Buffer.isBuffer(this.options.stdin) ? this.options.stdin.toString('utf8') : ''
-          };
+          });
           
           this.result = result;
           this.finished = true;
@@ -637,13 +662,13 @@ class ProcessRunner extends StreamEmitter {
       } else {
         // For system commands in pipeline, we would need to spawn processes
         // For now, return an error indicating this isn't supported
-        const result = {
+        const result = createResult({
           code: 1,
           stdout: currentOutput,
           stderr: `Pipeline with system command '${cmd}' not yet supported`,
           stdin: this.options.stdin && typeof this.options.stdin === 'string' ? this.options.stdin : 
                  this.options.stdin && Buffer.isBuffer(this.options.stdin) ? this.options.stdin.toString('utf8') : ''
-        };
+        });
         
         this.result = result;
         this.finished = true;
@@ -684,21 +709,21 @@ class ProcessRunner extends StreamEmitter {
       const destResult = await destination;
       
       // Return the final result with combined information
-      return {
+      return createResult({
         code: destResult.code,
         stdout: destResult.stdout,
         stderr: sourceResult.stderr + destResult.stderr,
         stdin: sourceResult.stdin
-      };
+      });
       
     } catch (error) {
-      const result = {
+      const result = createResult({
         code: error.code ?? 1,
         stdout: '',
         stderr: error.message || 'Pipeline execution failed',
         stdin: this.options.stdin && typeof this.options.stdin === 'string' ? this.options.stdin : 
                this.options.stdin && Buffer.isBuffer(this.options.stdin) ? this.options.stdin.toString('utf8') : ''
-      };
+      });
       
       this.result = result;
       this.finished = true;
@@ -846,16 +871,17 @@ class ProcessRunner extends StreamEmitter {
         stderr: 'pipe'
       });
       
-      result = {
+      result = createResult({
         code: proc.exitCode || 0,
         stdout: proc.stdout?.toString('utf8') || '',
         stderr: proc.stderr?.toString('utf8') || '',
         stdin: typeof stdin === 'string' ? stdin : 
-               Buffer.isBuffer(stdin) ? stdin.toString('utf8') : '',
-        child: proc
-      };
+               Buffer.isBuffer(stdin) ? stdin.toString('utf8') : ''
+      });
+      result.child = proc;
     } else {
       // Use Node's synchronous spawn
+      const require = createRequire(import.meta.url);
       const cp = require('child_process');
       const proc = cp.spawnSync(argv[0], argv.slice(1), {
         cwd,
@@ -866,14 +892,14 @@ class ProcessRunner extends StreamEmitter {
         stdio: ['pipe', 'pipe', 'pipe']
       });
       
-      result = {
+      result = createResult({
         code: proc.status || 0,
         stdout: proc.stdout || '',
         stderr: proc.stderr || '',
         stdin: typeof stdin === 'string' ? stdin : 
-               Buffer.isBuffer(stdin) ? stdin.toString('utf8') : '',
-        child: proc
-      };
+               Buffer.isBuffer(stdin) ? stdin.toString('utf8') : ''
+      });
+      result.child = proc;
     }
     
     // Mirror output if requested (but always capture for result)

package/README.md

@@ -14,7 +14,7 @@ A modern $ shell utility library with streaming, async iteration, and EventEmitt
 - 📡 **Real-time Streaming**: Process command output as it arrives, not after completion
 - 🔄 **Bun Optimized**: Designed for Bun runtime with Node.js compatibility
 - ⚡ **Performance**: Memory-efficient streaming prevents large buffer accumulation
-- 🎯 **Backward Compatible**: Existing `await $` syntax continues to work
+- 🎯 **Backward Compatible**: Existing `await $` syntax continues to work + Bun.$ `.text()` method
 - 🛡️ **Type Safe**: Full TypeScript support (coming soon)
 - 🔧 **Built-in Commands**: 18 essential commands work identically across platforms
 
@@ -29,6 +29,7 @@ A modern $ shell utility library with streaming, async iteration, and EventEmitt
 | **Async Iteration** | ✅ `for await (chunk of $.stream())` | ❌ No | ❌ No | ❌ No |
 | **EventEmitter Pattern** | ✅ `.on('data', ...)` | ❌ No | 🟡 Limited events | ❌ No |
 | **Mixed Patterns** | ✅ Events + await/sync | ❌ No | ❌ No | ❌ No |
+| **Bun.$ Compatibility** | ✅ `.text()` method support | ✅ Native API | ❌ No | ❌ No |
 | **Shell Injection Protection** | ✅ Auto-quoting | ✅ Built-in | ✅ Safe by default | ✅ Safe by default |
 | **Cross-platform** | ✅ macOS/Linux/Windows | ✅ Yes | ✅ Yes | ✅ Yes |
 | **Performance** | ⚡ Fast (Bun optimized) | ⚡ Very fast | 🐌 Moderate | 🐌 Slow |
@@ -695,10 +696,37 @@ All built-in commands support:
   stdout: string,      // Complete stdout output
   stderr: string,      // Complete stderr output
   stdin: string,       // Input sent to process
-  child: ChildProcess  // Original child process object
+  child: ChildProcess, // Original child process object
+  async text()         // Bun.$ compatibility method - returns stdout as string
 }
 ```
 
+#### `.text()` Method (Bun.$ Compatibility)
+
+For compatibility with Bun.$, all result objects include an async `.text()` method:
+
+```javascript
+import { $ } from 'command-stream';
+
+// Both sync and async execution support .text()
+const result1 = await $`echo "hello world"`;
+const text1 = await result1.text(); // "hello world\n"
+
+const result2 = $`echo "sync example"`.sync();  
+const text2 = await result2.text(); // "sync example\n"
+
+// .text() is equivalent to accessing .stdout
+expect(await result.text()).toBe(result.stdout);
+
+// Works with built-in commands
+const result3 = await $`seq 1 3`;
+const text3 = await result3.text(); // "1\n2\n3\n"
+
+// Works with .pipe() method
+const result4 = await $`echo "pipe test"`.pipe($`cat`);
+const text4 = await result4.text(); // "pipe test\n"
+```
+
 ## Testing
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "command-stream",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Modern $ shell utility library with streaming, async iteration, and EventEmitter support, optimized for Bun runtime",
   "type": "module",
   "main": "$.mjs",