Handle clearTerminal message by using vscode clear command #2316
Conversation
package.json
Outdated
| @@ -688,6 +688,10 @@ | |||
| "default": false, | |||
| "description": "Falls back to the legacy (lightweight) ReadLine experience. This will disable the use of PSReadLine in the PowerShell Integrated Console." | |||
| }, | |||
| "powershell.integratedConsole.useTrueClear": { | |||
There was a problem hiding this comment.
How about something like powershell.integrateConsole.clearScrollbackBuffer. Or slightly more futureproof maybe: "powershell.integratedConsole.clearAction": "scrollback" | "clear". Something with the term scrollback in it, just since TrueClear sounds a bit like a background check or a bad liquor to me.
There was a problem hiding this comment.
LOL
Ok. I kinda like the clearAction one. Let's go with that
There was a problem hiding this comment.
went with forceClearScrollbackBuffer because we can't change the behavior of clear-host other than forcing a full clear.
| ClearTerminalNotificationType, | ||
| () => { | ||
| // We check to see if they have TrueClear on. If not, no-op because the | ||
| // overriden Clear-Host already calls [System.Console]::Clear() |
There was a problem hiding this comment.
If Clear just triggered \x1b[3J it would work everywhere as that clears scrollback.
There was a problem hiding this comment.
So glad I cc'd you on that tweet - this is so much better
There was a problem hiding this comment.
Doesn't seem to work for me on Windows. Is support for the 3 option new? \x1b[2J works for me (in that it clears the current display) but \x1b[3J appears to be ignored.
There was a problem hiding this comment.
On Windows the compatibility layer might filter it out or something. I would expect this fix to be in the form of changing how clear acts in conpty to send ED 3 and 2 (i think) to clear the viewport and scrollback when Console.Clear is triggered. Maybe this is that issue? microsoft/terminal#2260
There was a problem hiding this comment.
@SeeminglyScience were you trying:
Write-Host "`e[3J"There was a problem hiding this comment.
damn ok - thought that maybe this would be viable but we'll probably have to do what this PR does and use the vscode API.
There was a problem hiding this comment.
@SeeminglyScience one more thing:
$([char]27)
There was a problem hiding this comment.
@TylerLeonhardt What about it?
There was a problem hiding this comment.
I got this from one of the Clear issues in the new Windows Terminal.
$host.UI.Write( "$([char]27)[3J$([char]27)[2J" ) It mostly works but requires a few tweaks. As is, the command leaves the cursor at the bottom so I expanded on it to reset the cursor to the top:
$host.UI.RawUI.CursorPosition = New-Object System.Management.Automation.Host.Coordinates 0,0
$host.UI.Write( "$([char]27)[3J$([char]27)[2J" ) It seems to work better in latest preview. Last time I tested this, I was still having to do manual Clear-Host in addition to it.
Remaining issue is the scrollbar doesn't reset so it looks like there is stuff there but there isn't. I still use VS Code's Clear to remove it.
There was a problem hiding this comment.
Yeah VS Code's Clear is probably the most reliable here but that's great info @dragonwolf83!
|
Thought I'd check in to see if this is any closer to being fixed? |
|
@Websure-Denzil This is a PR from 2019. Can you please open a new issue describing what needs to be fixed? |
|
Hi @andschwa , maybe I misunderstood - but I thought this was about the fact that Clear-Host from powershell does not work when running in visual studio code. Not to worry though, as I see this is closed after 3 years - Its clear there is no enthusiasm for fixing the bug. I will try to work around the issue. |
|
This was a PR written by an ex-maintainer three years ago implementing that feature (I think? I don't know, I didn't write nor review it, it was 2019). If something isn't work, please follow the bug report template to let me know what behavior you're expecting and the actual behavior you're seeing. I can't track bug reports from comments made on 3 year old merged PRs. |
|
If you take a look at the latest work being done, I would think you should say there is a lot of enthusiasm for fixing bugs 😀 |
PR Summary
This fixes an "issue" that comes up a lot that when you Clear-Host and are still able to scroll up.
On non-Windows this is the typical behavior of Clear-Host but on Windows the expectation is that the console is truly cleared out. This sends a message to the client to say "hey clear the terminal" and if the terminal properly supports a "true clear" in can register a handler for this notification.
Pairs with: PowerShell/PowerShellEditorServices#1108
PR Checklist
Note: Tick the boxes below that apply to this pull request by putting an
xbetween the square brackets.Please mark anything not applicable to this PR
NA.WIP:to the beginning of the title and remove the prefix when the PR is ready