Terminal "middle-out": smart truncation for terminal output#1390
Merged
Conversation
|
dosubot
bot
added
size:L
This was
linked to
issues
Mar 5, 2025
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
| @@ -0,0 +1,154 @@ | |||
| interface OutputBuilderOptions { | |||
| maxSize?: number // Max size of the buffer (in bytes). | |||
Contributor
There was a problem hiding this comment.
Consider updating the documentation for maxSize. Although the comment states it's in bytes, this implementation uses string length (code units), which may not match actual byte counts for Unicode. Clarify this to avoid confusion.
Suggested change
| maxSize?: number // Max size of the buffer (in bytes). | |
| maxSize?: number // Max size of the buffer (in code units, not bytes). |
This was
linked to
issues
Mar 5, 2025
This was
linked to
issues
Mar 5, 2025
Closed
cte
commented
Mar 5, 2025
dosubot
bot
added
size:XXL
cte
force-pushed
the
cte/terminal-middle-out
branch
from
ae3738b to
8bfcd83
Compare
cte
force-pushed
the
cte/terminal-middle-out
branch
from
0deaf60 to
7eee3e0
Compare
mrubens
approved these changes
Mar 6, 2025
This was referenced Mar 7, 2025
Closed
cte
pushed a commit
that referenced
this pull request
Mar 11, 2025
This reverts commit 7eee3e0. Middle-out truncation is a really great feature and it should still be implemented, however it unnecessarily interferes with #1365 because it hooked into the low-level chunk management that comes directly from VSCE shell integration. The best place to hook OutputBuilder is as follows depending on the state of terminal interaction: 1. Foreground terminals: Cline.ts: executeCommandTool(...) { process.on("line", (line) => { lines.push(line) ... } } 2. For background terminals: hook in at the point that getUnretrievedOutput is consumed for active or inactive terminals in Cline.ts:getEnvironmentDetails() Please note: The Terminal classes are very sensitive to change, partially because of the complicated way that shell integration works with VSCE, and partially because of the way that Cline interacts with the Terminal* class abstractions that make VSCE shell integration easier to work with. At the point that PR#1365 is merged, it is unlikely that any Terminal* classes will need to be modified substantially. Generally speaking, we should think of this is a stable interface and minimize changes. Reverts: #1390
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
2 participants
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.
Context
If the terminal output from a command exceeds 100KB then remove the middle of the output and just return the first 50KB and last 50KB. The 100KB limit is configurable:
Before:
3-million-hello-worlds-before.mp4
After:
3-million-hello-worlds-after.mp4
Implementation
We now have an
OutputBuilderobject that you can append text to and it will maintain two buffers if themaxSizeis exceeded. It also supports cursor-based reads from the buffer so we can properly implementgetUnretrievedOutput.How to Test
Get in Touch
Important
Adds
OutputBuilderfor smart truncation of terminal output, updates settings for output limit, and includes comprehensive tests.OutputBuilderclass inOutputBuilder.tsfor smart truncation of terminal output, preserving start and end.truncateOutputwithOutputBuilderinCline.tsandTerminalManager.ts.TERMINAL_OUTPUT_LIMITconstant interminal.ts.terminalOutputLimitsetting inExtensionStateContext.tsx,AdvancedSettings.tsx, andSettingsView.tsx.WebviewMessage.tsandExtensionMessage.tsto handleterminalOutputLimit.OutputBuilderinOutputBuilder.test.ts.TerminalProcess.test.tsandmergePromise.test.tsto reflect new behavior.truncateOutputfromextract-text.tsand related tests.This description was created by
for 7eee3e0. It will automatically update as commits are pushed.