PSReadLine icon indicating copy to clipboard operation
PSReadLine copied to clipboard

Buggy interaction between the option `PromptText` and a prompt with shell integration in Windows Terminal 1.22.10352.0 (v 2.4.0 beta0)

Open matteocoder opened this issue 10 months ago • 0 comments

Prerequisites

  • [x] Write a descriptive title.
  • [x] Make sure you are able to repro it on the latest released version
  • [x] Search the existing issues, especially the pinned issues.

Exception report

N/A

Screenshot

Image

Environment data

PS Version: 7.6.0-preview.2
PS HostName: ConsoleHost (Windows Terminal)
PSReadLine Version: 2.4.0-beta0
PSReadLine EditMode: Emacs
OS: 10.0.26100.1 (WinBuild.160101.0800)
BufferWidth: 120
BufferHeight: 24
Terminal: Windows Terminal  1.22.10352.0

Steps to reproduce

  1. Define your prompt as follows
function prompt {
        # Get error code
    $LastExitStatus = $?
    $LastHistoryEntry = Get-History -Count 1
    $LastErrorId = $Error[0].InvocationInfo.HistoryId
    $CapturedExitCode = $LastExitCode
    [int]$errorCode = 0
    [bool]$IsLastResultAnError = $LastErrorId -eq $LastHistoryEntry.Id
    if ($LastexitStatus -eq $True) {
        $errorCode = 0
    }
    elseif ($IsLastResultAnError) {
        $errorCode = -1
    }
    else {
        $errorCode = $CapturedExitCode
    }
    $p = [System.Text.StringBuilder]::new()
    # Get end mark
    if ($global:_lastHistoryId -ne -1) {
        if ($LastHistoryEntry.Id -eq $global:_lastHistoryId) {
            [void]$p.Append("`e]133;D`a")
        }
        else {
            [void]$p.Append("`e]133;D;$errorCode`a")
        }
    }
    $Global:_lastHistoryId = $lastHistoryEntry.Id
    # Start of the prompt
    [void]$p.Append("`e]133;A$([char]07)")
    # Get location mark
    $Location = $executionContext.SessionState.Path.CurrentLocation
    if ($Location.Provider.Name -eq "FileSystem") {
        [void]$p.Append("$([char]27)]9;9;`"$($Location.ProviderPath)`"$([char]27)\")
    }
    [void]$p.Append("PS > ")
    # End of the prompt, start of the new command
    [void]$p.Append("`e]133;B$([char]07)")
    $p.ToString()
  1. Set-PSReadlineOption -PromptText '>'; Set-PSReadlineOption -ExtraPromptLineCount 1
  2. Write any PowerShell code, triggering a syntax error in the meantime (for instance, open a parenthesis)
  3. Write the command correctly, then execute

Expected behavior

The prompt text should be substituted cleanly, and not leave any spurious characters in the command line.

Actual behavior

The PromptText character is inserted into the command line, and as a consequence it is erroneously detected as part of the command by the shell integration feature.

Links

More information about the shell integration feature in Windows Terminal.

matteocoder avatar Feb 24 '25 18:02 matteocoder