command-stream 0.3.1 → 0.4.0

package/README.md

@@ -1,3 +1,6 @@
+[![npm](https://img.shields.io/npm/v/command-stream.svg)](https://npmjs.com/command-stream)
+[![License](https://img.shields.io/badge/license-Unlicense-blue.svg)](https://github.com/link-foundation/command-stream/blob/main/LICENSE)
+
 [![Open in Gitpod](https://img.shields.io/badge/Gitpod-ready--to--code-f29718?logo=gitpod)](https://gitpod.io/#https://github.com/link-foundation/command-stream)
 [![Open in GitHub Codespaces](https://img.shields.io/badge/GitHub%20Codespaces-Open-181717?logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=link-foundation/command-stream)
 
@@ -23,31 +26,39 @@ A modern $ shell utility library with streaming, async iteration, and EventEmitt
 
 ## Comparison with Other Libraries
 
-| Feature | [command-stream](https://github.com/link-foundation/command-stream) | [Bun.$](https://bun.sh/docs/runtime/shell) | [execa](https://github.com/sindresorhus/execa) | [zx](https://github.com/google/zx) |
-|---------|----------------|-------|-------|-----|
-| **Runtime Support** | ✅ Bun + Node.js | 🟡 Bun only | ✅ Node.js | ✅ Node.js |
-| **Template Literals** | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` |
-| **Real-time Streaming** | ✅ Live output | ❌ Buffer only | 🟡 Limited | ❌ Buffer only |
-| **Synchronous Execution** | ✅ `.sync()` with events | ❌ No | ✅ `execaSync` | ❌ No |
-| **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 |
-| **Memory Efficiency** | ✅ Streaming prevents buildup | 🟡 Buffers in memory | 🟡 Buffers in memory | 🟡 Buffers in memory |
-| **Error Handling** | ✅ Configurable (`set -e`/`set +e`, non-zero OK by default) | ✅ Throws on error | ✅ Throws on error | ✅ Throws on error |
-| **Shell Settings** | ✅ `set -e`/`set +e` equivalent | ❌ No | ❌ No | ❌ No |
-| **Stdout Support** | ✅ Real-time streaming + events | ✅ Shell redirection + buffered | ✅ Node.js streams + interleaved | ✅ Readable streams + `.pipe.stdout` |
-| **Stderr Support** | ✅ Real-time streaming + events | ✅ Redirection + `.quiet()` access | ✅ Streams + interleaved output | ✅ Readable streams + `.pipe.stderr` |
-| **Stdin Support** | ✅ string/Buffer/inherit/ignore | ✅ Pipe operations | ✅ Input/output streams | ✅ Basic stdin |
-| **Built-in Commands** | ✅ **18 commands**: cat, ls, mkdir, rm, mv, cp, touch, basename, dirname, seq, yes + all Bun.$ commands | ✅ echo, cd, etc. | ❌ Uses system | ❌ Uses system |
-| **Virtual Commands Engine** | ✅ **Revolutionary**: Register JavaScript functions as shell commands with full pipeline support | ❌ No extensibility | ❌ No custom commands | ❌ No custom commands |
-| **Pipeline/Piping Support** | ✅ **Advanced**: System + Built-ins + Virtual + Mixed + `.pipe()` method | ✅ Standard shell piping | ✅ Programmatic `.pipe()` + multi-destination | ✅ Shell piping + `.pipe()` method |
-| **Bundle Size** | 📦 ~15KB | 🎯 0KB (built-in) | 📦 ~25KB | 📦 ~50KB |
-| **TypeScript** | 🔄 Coming soon | ✅ Built-in | ✅ Full support | ✅ Full support |
-| **License** | ✅ **Unlicense (Public Domain)** | 🟡 MIT (+ LGPL dependencies) | 🟡 MIT | 🟡 Apache 2.0 |
+| Feature | [command-stream](https://github.com/link-foundation/command-stream) | [Bun.$](https://bun.sh/docs/runtime/shell) | [execa](https://github.com/sindresorhus/execa) | [zx](https://github.com/google/zx) | [ShellJS](https://github.com/shelljs/shelljs) | [cross-spawn](https://github.com/moxystudio/node-cross-spawn) |
+|---------|----------------|-------|-------|-----|-------|-------|
+| **Runtime Support** | ✅ Bun + Node.js | 🟡 Bun only | ✅ Node.js | ✅ Node.js | ✅ Node.js | ✅ Node.js |
+| **Template Literals** | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` | ✅ `` $`cmd` `` | ❌ Function calls | ❌ Function calls |
+| **Real-time Streaming** | ✅ Live output | ❌ Buffer only | 🟡 Limited | ❌ Buffer only | ❌ Buffer only | ❌ Buffer only |
+| **Synchronous Execution** | ✅ `.sync()` with events | ❌ No | ✅ `execaSync` | ❌ No | ✅ Sync by default | ✅ `spawnSync` |
+| **Async Iteration** | ✅ `for await (chunk of $.stream())` | ❌ No | ❌ No | ❌ No | ❌ No | ❌ No |
+| **EventEmitter Pattern** | ✅ `.on('data', ...)` | ❌ No | 🟡 Limited events | ❌ No | ❌ No | 🟡 Child process events |
+| **Mixed Patterns** | ✅ Events + await/sync | ❌ No | ❌ No | ❌ No | ❌ No | ❌ No |
+| **Bun.$ Compatibility** | ✅ `.text()` method support | ✅ Native API | ❌ No | ❌ No | ❌ No | ❌ No |
+| **Shell Injection Protection** | ✅ Auto-quoting | ✅ Built-in | ✅ Safe by default | ✅ Safe by default | 🟡 Manual escaping | ✅ Safe by default |
+| **Cross-platform** | ✅ macOS/Linux/Windows | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ **Specialized** cross-platform |
+| **Performance** | ⚡ Fast (Bun optimized) | ⚡ Very fast | 🐌 Moderate | 🐌 Slow | 🐌 Moderate | ⚡ Fast |
+| **Memory Efficiency** | ✅ Streaming prevents buildup | 🟡 Buffers in memory | 🟡 Buffers in memory | 🟡 Buffers in memory | 🟡 Buffers in memory | 🟡 Buffers in memory |
+| **Error Handling** | ✅ Configurable (`set -e`/`set +e`, non-zero OK by default) | ✅ Throws on error | ✅ Throws on error | ✅ Throws on error | ✅ Configurable | ❌ Basic (exit codes) |
+| **Shell Settings** | ✅ `set -e`/`set +e` equivalent | ❌ No | ❌ No | ❌ No | 🟡 Limited (`set()`) | ❌ No |
+| **Stdout Support** | ✅ Real-time streaming + events | ✅ Shell redirection + buffered | ✅ Node.js streams + interleaved | ✅ Readable streams + `.pipe.stdout` | ✅ Direct output | ✅ Inherited/buffered |
+| **Stderr Support** | ✅ Real-time streaming + events | ✅ Redirection + `.quiet()` access | ✅ Streams + interleaved output | ✅ Readable streams + `.pipe.stderr` | ✅ Error output | ✅ Inherited/buffered |
+| **Stdin Support** | ✅ string/Buffer/inherit/ignore | ✅ Pipe operations | ✅ Input/output streams | ✅ Basic stdin | 🟡 Basic | ✅ Full stdio support |
+| **Built-in Commands** | ✅ **18 commands**: cat, ls, mkdir, rm, mv, cp, touch, basename, dirname, seq, yes + all Bun.$ commands | ✅ echo, cd, etc. | ❌ Uses system | ❌ Uses system | ✅ **20+ commands**: cat, ls, mkdir, rm, mv, cp, etc. | ❌ Uses system |
+| **Virtual Commands Engine** | ✅ **Revolutionary**: Register JavaScript functions as shell commands with full pipeline support | ❌ No extensibility | ❌ No custom commands | ❌ No custom commands | ❌ No custom commands | ❌ No custom commands |
+| **Pipeline/Piping Support** | ✅ **Advanced**: System + Built-ins + Virtual + Mixed + `.pipe()` method | ✅ Standard shell piping | ✅ Programmatic `.pipe()` + multi-destination | ✅ Shell piping + `.pipe()` method | ✅ Shell piping + `.to()` method | ❌ No piping |
+| **Bundle Size** | 📦 **~20KB gzipped** | 🎯 0KB (built-in) | 📦 ~400KB+ (packagephobia) | 📦 ~50KB+ (estimated) | 📦 ~15KB gzipped | 📦 ~2KB gzipped |
+| **Signal Handling** | ✅ **Advanced SIGINT/SIGTERM forwarding** with cleanup | 🟡 Basic | 🟡 Basic | 🟡 Basic | 🟡 Basic | ✅ **Excellent** cross-platform |
+| **Process Management** | ✅ **Robust child process lifecycle** with proper termination | ❌ Basic | ✅ Good | 🟡 Limited | 🟡 Limited | ✅ **Excellent** spawn wrapper |
+| **Debug Tracing** | ✅ **Comprehensive VERBOSE logging** for CI/debugging | ❌ No | 🟡 Limited | ❌ No | 🟡 Basic | ❌ No |
+| **Test Coverage** | ✅ **410 tests, 909 assertions** | 🟡 Good coverage | ✅ Excellent | 🟡 Good | ✅ Good | ✅ Good |
+| **CI Reliability** | ✅ **Platform-specific handling** (macOS/Ubuntu) | 🟡 Basic | ✅ Good | 🟡 Basic | ✅ Good | ✅ **Excellent** |
+| **Documentation** | ✅ **Comprehensive examples + guides** | ✅ Good | ✅ Excellent | 🟡 Limited | ✅ Good | 🟡 Basic |
+| **TypeScript** | 🔄 Coming soon | ✅ Built-in | ✅ Full support | ✅ Full support | 🟡 Community types | ✅ Built-in |
+| **License** | ✅ **Unlicense (Public Domain)** | 🟡 MIT (+ LGPL dependencies) | 🟡 MIT | 🟡 Apache 2.0 | 🟡 BSD-3-Clause | 🟡 MIT |
+
+**📊 Popularity (Weekly Downloads 2024):** [cross-spawn](https://www.npmjs.com/package/cross-spawn): 102M+ • [execa](https://www.npmjs.com/package/execa): 98M+ • [ShellJS](https://www.npmjs.com/package/shelljs): 9M+ • [zx](https://www.npmjs.com/package/zx): Growing fast
 
 ### Why Choose command-stream?
 
@@ -60,7 +71,9 @@ A modern $ shell utility library with streaming, async iteration, and EventEmitt
 - **🐚 Shell Replacement**: Dynamic error handling with `set -e`/`set +e` equivalents for .sh file replacement
 - **⚡ Bun Optimized**: Designed for Bun with Node.js fallback compatibility  
 - **💾 Memory Efficient**: Streaming prevents large buffer accumulation
-- **🛡️ Production Ready**: 266+ tests with comprehensive coverage
+- **🛡️ Production Ready**: **410 tests, 909 assertions** with comprehensive coverage including CI reliability
+- **🎯 Advanced Signal Handling**: Robust SIGINT/SIGTERM forwarding with proper child process cleanup
+- **🔍 Debug-Friendly**: Comprehensive VERBOSE tracing for CI debugging and troubleshooting
 
 ## Built-in Commands (🚀 NEW!)
 
@@ -140,6 +153,42 @@ console.log(result.stdout);
 console.log(result.code); // exit code
 ```
 
+### Custom Options with $({ options }) Syntax (NEW!)
+
+```javascript
+import { $ } from 'command-stream';
+
+// Create a $ with custom options
+const $silent = $({ mirror: false, capture: true });
+const result = await $silent`echo "quiet operation"`;
+
+// Options for stdin handling
+const $withInput = $({ stdin: 'input data\n' });
+await $withInput`cat`; // Pipes the input to cat
+
+// Custom environment variables
+const $withEnv = $({ env: { ...process.env, MY_VAR: 'value' } });
+await $withEnv`printenv MY_VAR`; // Prints: value
+
+// Custom working directory
+const $inTmp = $({ cwd: '/tmp' });
+await $inTmp`pwd`; // Prints: /tmp
+
+// Combine multiple options
+const $custom = $({
+  stdin: 'test data',
+  mirror: false,
+  capture: true,
+  cwd: '/tmp'
+});
+await $custom`cat > output.txt`; // Writes to /tmp/output.txt silently
+
+// Reusable configurations
+const $prod = $({ env: { NODE_ENV: 'production' }, capture: true });
+await $prod`npm start`;
+await $prod`npm test`;
+```
+
 ### Execution Control (NEW!)
 
 ```javascript
@@ -660,7 +709,8 @@ The enhanced `$` function returns a `ProcessRunner` instance that extends `Event
 - `env: object` - Environment variables
 
 **Override defaults:**
-- Use `sh(command, options)` for one-off overrides
+- Use `$({ options })` syntax for one-off configurations with template literals
+- Use `sh(command, options)` for one-off overrides with string commands
 - Use `create(defaultOptions)` to create custom `$` with different defaults
 
 ### Shell Settings API
@@ -676,6 +726,38 @@ Control shell behavior like bash `set`/`unset` commands:
 - `unset(option)`: Disable shell option
 - `shell.settings()`: Get current settings object
 
+#### Error Handling Modes
+
+```javascript
+import { $, shell } from 'command-stream';
+
+// ✅ Default behavior: Commands don't throw on non-zero exit
+const result = await $`ls nonexistent-file`; // Won't throw
+console.log(result.code); // → 2 (non-zero, but no exception)
+
+// ✅ Enable errexit: Commands throw on non-zero exit
+shell.errexit(true);
+try {
+  await $`ls nonexistent-file`; // Throws error
+} catch (error) {
+  console.log('Command failed:', error.code); // → 2
+}
+
+// ✅ Disable errexit: Back to non-throwing behavior
+shell.errexit(false);
+await $`ls nonexistent-file`; // Won't throw, returns result with code 2
+
+// ✅ One-time override without changing global settings
+try {
+  const result = await $`ls nonexistent-file`;
+  if (result.code !== 0) {
+    throw new Error(`Command failed with code ${result.code}`);
+  }
+} catch (error) {
+  console.log('Manual error handling');
+}
+```
+
 ### Virtual Commands API
 
 Control and extend the command system with custom JavaScript functions:
@@ -690,6 +772,54 @@ Control and extend the command system with custom JavaScript functions:
 - `enableVirtualCommands()`: Enable virtual command processing
 - `disableVirtualCommands()`: Disable virtual commands (use system commands only)
 
+#### Advanced Virtual Command Features
+
+```javascript
+import { $, register } from 'command-stream';
+
+// ✅ Cancellation support with AbortController
+register('cancellable', async function* (args, stdin, options) {
+  for (let i = 0; i < 10; i++) {
+    if (options.signal?.aborted) {
+      break; // Proper cancellation handling
+    }
+    yield `Count: ${i}\n`;
+    await new Promise(resolve => setTimeout(resolve, 1000));
+  }
+});
+
+// ✅ Access to all process options
+register('debug-info', async (args, stdin, options) => {
+  return {
+    stdout: JSON.stringify({
+      args,
+      cwd: options.cwd,
+      env: Object.keys(options.env || {}),
+      stdinLength: stdin.length,
+      mirror: options.mirror,
+      capture: options.capture
+    }, null, 2),
+    code: 0
+  };
+});
+
+// ✅ Error handling and non-zero exit codes
+register('maybe-fail', async (args) => {
+  if (Math.random() > 0.5) {
+    return {
+      stdout: 'Success!\n',
+      code: 0
+    };
+  } else {
+    return {
+      stdout: '',
+      stderr: 'Random failure occurred\n',
+      code: 1
+    };
+  }
+});
+```
+
 #### Handler Function Signature
 
 ```javascript
@@ -771,10 +901,172 @@ const result4 = await $`echo "pipe test"`.pipe($`cat`);
 const text4 = await result4.text(); // "pipe test\n"
 ```
 
+## Signal Handling (CTRL+C Support)
+
+The library provides **advanced CTRL+C handling** that properly manages signals across different scenarios:
+
+### How It Works
+
+1. **Smart Signal Forwarding**: CTRL+C is forwarded **only when child processes are active**
+2. **User Handler Preservation**: When no children are running, your custom SIGINT handlers work normally
+3. **Process Groups**: Child processes use detached spawning for proper signal isolation
+4. **TTY Mode Support**: Raw TTY mode is properly managed and restored on interruption
+5. **Graceful Termination**: Uses SIGTERM → SIGKILL escalation for robust process cleanup
+6. **Exit Code Standards**: Proper signal exit codes (130 for SIGINT, 143 for SIGTERM)
+
+### Advanced Signal Behavior
+
+```javascript
+// ✅ Smart signal handling - only interferes when necessary
+import { $ } from 'command-stream';
+
+// Case 1: No children active - your handlers work normally  
+process.on('SIGINT', () => {
+  console.log('My custom handler runs!');
+  process.exit(42); // Custom exit code
+});
+// Press CTRL+C → Your handler runs, exits with code 42
+
+// Case 2: Children active - automatic forwarding
+await $`ping 8.8.8.8`; // Press CTRL+C → Forwards to ping, exits with code 130
+
+// Case 3: Multiple processes - all interrupted
+await Promise.all([
+  $`sleep 100`,
+  $`ping google.com`  
+]); // Press CTRL+C → All processes terminated, exits with code 130
+```
+
+### Examples
+
+```javascript
+// Long-running command that can be interrupted with CTRL+C
+try {
+  await $`ping 8.8.8.8`;  // Press CTRL+C to stop
+} catch (error) {
+  console.log('Command interrupted:', error.code); // Exit code 130 (SIGINT)
+}
+
+// Multiple concurrent processes - CTRL+C stops all
+try {
+  await Promise.all([
+    $`sleep 100`,
+    $`ping google.com`,
+    $`tail -f /var/log/system.log`
+  ]);
+} catch (error) {
+  // All processes are terminated when you press CTRL+C
+}
+
+// Works with streaming patterns too
+try {
+  for await (const chunk of $`ping 8.8.8.8`.stream()) {
+    console.log(chunk);
+    // Press CTRL+C to break the loop and stop the process
+  }
+} catch (error) {
+  console.log('Streaming interrupted');
+}
+```
+
+### Signal Handling Behavior
+
+- **🎯 Smart Detection**: Only forwards CTRL+C when child processes are active
+- **🛡️ Non-Interference**: Preserves user SIGINT handlers when no children running  
+- **⚡ Interactive Commands**: Commands like `vim`, `less`, `top` work with their own signal handling
+- **🔄 Process Groups**: Detached spawning ensures proper signal isolation
+- **🧹 TTY Cleanup**: Raw terminal mode properly restored on interruption
+- **📊 Standard Exit Codes**: 
+  - `130` - SIGINT interruption (CTRL+C)
+  - `143` - SIGTERM termination (programmatic kill)
+  - `137` - SIGKILL force termination
+
+### Command Resolution Priority
+
+```javascript
+// Understanding how commands are resolved:
+
+// 1. Virtual Commands (highest priority)
+register('echo', () => ({ stdout: 'virtual!\n', code: 0 }));
+await $`echo test`; // → "virtual!"
+
+// 2. Built-in Commands (if no virtual match)  
+unregister('echo');
+await $`echo test`; // → Uses built-in echo
+
+// 3. System Commands (if no built-in/virtual match)
+await $`unknown-command`; // → Uses system PATH lookup
+
+// 4. Virtual Bypass (special case)
+await $({ stdin: 'data' })`sleep 1`; // Bypasses virtual sleep, uses system sleep
+```
+
+## Execution Patterns Deep Dive
+
+### When to Use Different Patterns
+
+```javascript
+import { $ } from 'command-stream';
+
+// ✅ Use await for simple command execution
+const result = await $`ls -la`;
+
+// ✅ Use .sync() when you need blocking execution with events
+const syncCmd = $`build-script`
+  .on('stdout', chunk => updateProgress(chunk))
+  .sync(); // Events fire after completion
+
+// ✅ Use .start() for non-blocking execution with real-time events  
+const asyncCmd = $`long-running-server`
+  .on('stdout', chunk => logOutput(chunk))
+  .start(); // Events fire in real-time
+
+// ✅ Use .stream() for processing large outputs efficiently
+for await (const chunk of $`generate-big-file`.stream()) {
+  processChunkInRealTime(chunk);
+} // Memory efficient - processes chunks as they arrive
+
+// ✅ Use EventEmitter pattern for complex workflows
+$`deployment-script`
+  .on('stdout', chunk => {
+    if (chunk.toString().includes('ERROR')) {
+      handleError(chunk);
+    }
+  })
+  .on('stderr', chunk => logError(chunk))
+  .on('end', result => {
+    if (result.code === 0) {
+      notifySuccess();
+    }
+  })
+  .start();
+```
+
+### Performance Considerations
+
+```javascript
+// 🚀 Memory Efficient: For large outputs, use streaming
+for await (const chunk of $`cat huge-file.log`.stream()) {
+  processChunk(chunk); // Processes incrementally
+}
+
+// 🐌 Memory Inefficient: Buffers entire output in memory
+const result = await $`cat huge-file.log`;
+processFile(result.stdout); // Loads everything into memory
+
+// ⚡ Fastest: Sync execution for small, quick commands
+const quickResult = $`pwd`.sync();
+
+// 🔄 Best for UX: Async with events for long-running commands
+$`npm install`
+  .on('stdout', showProgress)
+  .start();
+```
+
 ## Testing
 
 ```bash
-# Run comprehensive test suite (266 tests)
+# Run comprehensive test suite (270+ tests)
 bun test
 
 # Run tests with coverage report
@@ -782,9 +1074,10 @@ bun test --coverage
 
 # Run specific test categories
 npm run test:features    # Feature comparison tests
-npm run test:builtin     # Built-in commands tests
+npm run test:builtin     # Built-in commands tests  
 npm run test:pipe        # .pipe() method tests
 npm run test:sync        # Synchronous execution tests
+npm run test:signal      # CTRL+C signal handling tests
 ```
 
 ## Requirements

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "command-stream",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Modern $ shell utility library with streaming, async iteration, and EventEmitter support, optimized for Bun runtime",
   "type": "module",
-  "main": "$.mjs",
+  "main": "src/$.mjs",
   "exports": {
-    ".": "./$.mjs"
+    ".": "./src/$.mjs"
   },
   "repository": {
     "type": "git",
@@ -43,7 +43,7 @@
     "node": ">=20.0.0"
   },
   "files": [
-    "$.mjs",
+    "src/",
     "README.md",
     "LICENSE"
   ]