Buggy interaction between the option `PromptText` and a prompt with shell integration in Windows Terminal 1.22.10352.0 (v 2.4.0 beta0)
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
Research direction
Start by reproducing the interaction with Set-PSReadLineOption using PromptText and ExtraPromptLineCount, following the prompt function and Windows Terminal shell-integration sequence in the issue. Compare behavior after a syntax error and corrected command execution. Done means PromptText is substituted without inserting spurious characters or causing shell integration to treat it as command input.
Written by the indexing model from the issue text.
Description
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest released version
- Search the existing issues, especially the pinned issues.
Exception report
N/A
Screenshot
Environment data
PS Version: 7.6.0-preview.4
PS HostName: ConsoleHost (Windows Terminal)
PSReadLine Version: 2.4.5
PSReadLine EditMode: Windows
OS: 10.0.26100.1 (WinBuild.160101.0800)
BufferWidth: 120
BufferHeight: 24
Windows Terminal 1.23.12811.0
Steps to reproduce
- Define your
promptas 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()
}
Set-PSReadlineOption -PromptText '>'; Set-PSReadlineOption -ExtraPromptLineCount 1- Write any PowerShell code, triggering a syntax error in the meantime (for instance, open a parenthesis)
- 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.
- Dominant language
- C#
- Stars
- 4.4k
- Forks
- 341
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/PSReadLine
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSReadLine#5205 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PowerShell/PSReadLine#5195 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PowerShell/PSReadLine#5121 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
PowerShell/PSReadLine#5045 ·
-
Area-CommandHelp Issue-Enhancement
Difficulty 1/5 Under an hour Newbie friendliness 68/100
PowerShell/PSReadLine#3470 · 3 reactions ·
All issues in PowerShell/PSReadLine
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 75/100
sillsdev/languageforge-lexbox#2665 ·
-
bug documentation frontend
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
azurenoops/spin_agent#975 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·