Handle clearTerminal message by using vscode clear command by TylerLeonhardt · Pull Request #2316 · PowerShell/vscode-powershell

TylerLeonhardt · 2019-11-19T05:43:15Z

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 x between the square brackets.
Please mark anything not applicable to this PR NA.

PR has a meaningful title
Summarized changes
PR has tests
This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

rjmholt · 2019-11-19T06:34:58Z

package.json

          "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": {


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.

LOL

Ok. I kinda like the clearAction one. Let's go with that

went with forceClearScrollbackBuffer because we can't change the behavior of clear-host other than forcing a full clear.

Tyriar · 2019-11-19T14:47:18Z

src/features/ExtensionCommands.ts

+                ClearTerminalNotificationType,
+                () => {
+                    // We check to see if they have TrueClear on. If not, no-op because the
+                    // overriden Clear-Host already calls [System.Console]::Clear()


If Clear just triggered \x1b[3J it would work everywhere as that clears scrollback.

https://github.com/xtermjs/xterm.js/blob/70babeacb62fe05264d64324ca1f4436997efa1b/src/InputHandler.ts#L908-L918

So glad I cc'd you on that tweet - this is so much better

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.

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

@SeeminglyScience were you trying:

Write-Host "`e[3J"

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.

@SeeminglyScience one more thing:

$([char]27)

@TylerLeonhardt What about it?

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.

Yeah VS Code's Clear is probably the most reliable here but that's great info @dragonwolf83!

Websure-Denzil · 2022-02-01T16:23:40Z

Thought I'd check in to see if this is any closer to being fixed?

andyleejordan · 2022-02-01T18:40:39Z

@Websure-Denzil This is a PR from 2019. Can you please open a new issue describing what needs to be fixed?

Websure-Denzil · 2022-02-01T18:55:28Z

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.
Since this is still the case as far as I am aware, it certainly is for me I wondered if there was any official answer.

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.

andyleejordan · 2022-02-01T18:58:26Z

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.

andyleejordan · 2022-02-01T18:58:56Z

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 😀

TylerLeonhardt added 2 commits November 18, 2019 21:41

handle clearTerminal message by using vscode clear command

c4ef11c

Codacy

0efeb46

TylerLeonhardt mentioned this pull request Nov 19, 2019

Clear-Host does not clear terminal window #1955

Closed

rjmholt reviewed Nov 19, 2019

View reviewed changes

TylerLeonhardt mentioned this pull request Nov 19, 2019

Have an option for the integrated terminal to behave more like PowerShell ISE. #2307

Open

Tyriar reviewed Nov 19, 2019

View reviewed changes

This was referenced Nov 19, 2019

Alt: Handle clearTerminal message by using vscode clear command #2318

Closed

Clear the terminal via the LSP PowerShell/PowerShellEditorServices#1108

Merged

TylerLeonhardt added 2 commits November 21, 2019 11:49

changed name of setting

05056bb

delete comment

62fff5b

rjmholt approved these changes Nov 26, 2019

View reviewed changes

TylerLeonhardt merged commit fb59b37 into PowerShell:master Nov 27, 2019

JustinGrote mentioned this pull request Dec 19, 2019

[Preview] [PSES] Clear-Host Error Recorded in PSES Log for Powershell 5.1 #2379

Closed

PrzemyslawKlys mentioned this pull request Feb 18, 2020

Clear-Host does not clear the previous content (Powershell) microsoft/terminal#3126

Closed

TylerLeonhardt deleted the clear-terminal-via-lsp branch August 10, 2020 15:04

PowerShell locked as off-topic and limited conversation to collaborators Feb 1, 2022

Conversation

TylerLeonhardt commented Nov 19, 2019

PR Summary

PR Checklist

Uh oh!

rjmholt Nov 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Tyriar Nov 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TylerLeonhardt Nov 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Websure-Denzil commented Feb 1, 2022

Uh oh!

andyleejordan commented Feb 1, 2022

Uh oh!

Websure-Denzil commented Feb 1, 2022

Uh oh!

andyleejordan commented Feb 1, 2022

Uh oh!

andyleejordan commented Feb 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rjmholt Nov 19, 2019 •

edited

Loading

Tyriar Nov 19, 2019 •

edited

Loading

TylerLeonhardt Nov 19, 2019 •

edited

Loading