Implement real streams or stream wrappers for result objects#127
Open
Implement real streams or stream wrappers for result objects#127
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #19
This commit implements the requested feature to return real streams
or stream wrappers instead of plain strings for result.stdout,
result.stderr, and result.stdin.
## Implementation Details
### Stream Wrappers
- Created `ReadableStreamWrapper` class extending Node.js `Readable`
- Created `WritableStreamWrapper` class extending Node.js `Writable`
- Both classes provide full backward compatibility with string methods
- Support all common string operations: trim(), slice(), includes(), etc.
- Proper JSON serialization via toJSON() method
- Custom inspection for console.log
### Core Changes
- Modified `createResult()` function to return stream wrappers
- Updated virtual command result processing to use createResult
- Fixed stdin data handling for virtual commands
- Added proper capture/non-capture mode handling
### Stream Functionality
- Full Node.js stream compatibility (pipe, read, write, on, etc.)
- Readable streams for stdout and stderr
- Writable streams for stdin
- Stream events (data, end, finish) work correctly
- Proper stream lifecycle management
### Backward Compatibility
- All string methods work unchanged: result.stdout.trim()
- String coercion works: String(result.stdout)
- JSON serialization preserved: JSON.stringify(result.stdout)
- Template literal interpolation: `Output: ${result.stdout}`
### Breaking Changes
- typeof result.stdout changed from 'string' to 'object'
- This is intentional and matches the issue requirements
- Stream objects behave like strings but are technically objects
### Testing
- Added comprehensive test suite for stream functionality
- Tests verify stream behavior, backward compatibility, and edge cases
- All new stream-specific functionality is fully tested
## Example Usage
```javascript
const result = await $`echo "hello world"`;
// Stream usage (new functionality)
result.stdout.on('data', chunk => console.log(chunk));
result.stdout.pipe(process.stdout);
// String usage (backward compatible)
console.log(result.stdout.trim()); // "hello world"
console.log(result.stdout.length); // 12
```
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements issue #19 by replacing plain string properties in result objects with real Node.js stream wrappers, while maintaining full backward compatibility.
🔧 Implementation
Stream Wrappers:
ReadableStreamWrapperforstdoutandstderrWritableStreamWrapperforstdinReadable/Writable)pipe(),read(),write(), events, etc.Core Changes:
createResult()to return stream wrappers instead of stringsBackward Compatibility:
trim(),slice(),includes(), etc.String(result.stdout)✅JSON.stringify(result.stdout)✅Output: ${result.stdout}✅💥 Breaking Changes
typeof result.stdoutchanges from'string'to'object'🧪 Test Plan
📖 Example Usage
🏁 Status
✅ Ready for Review - Implementation complete with full test coverage
🤖 Generated with Claude Code
Resolves #19