fix: strip osc from prompt detection (#256)

Signed-off-by: Chapman Pendery <[email protected]>
microsoft · May 7, 2024 · 2269665 · 2269665
1 parent ae6e6e1
commit 2269665
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 7 deletions.
diff --git a/shell/shellIntegration-rc.zsh b/shell/shellIntegration-rc.zsh
@@ -25,6 +25,12 @@ __is_escape_value() {
  token="\\\\"
  elif [ "$byte" = ";" ]; then
  token="\\x3b"
+ elif [ "$byte" = $'\n' ]; then
+ token="\x0a"
+ elif [ "$byte" = $'\e' ]; then
+ token="\\x1b"
+ elif [ "$byte" = $'\a' ]; then
+ token="\\x07"
  else
  token="$byte"
  fi

diff --git a/shell/shellIntegration.bash b/shell/shellIntegration.bash
@@ -44,6 +44,8 @@ __is_escape_value() {
  token="\x0a"
  elif [ "$byte" = $'\e' ]; then
  token="\\x1b"
+ elif [ "$byte" = $'\a' ]; then
+ token="\\x07"
  else
  token="$byte"
  fi

diff --git a/shell/shellIntegration.fish b/shell/shellIntegration.fish
@@ -9,6 +9,7 @@ function __is_escape_value
  | string replace -a '\\' '\\\\' \
  | string replace -a ';' '\\x3b' \
  | string replace -a \e '\\x1b' \
+ | string replace -a \a '\\x07' \
  | string split \n | string join '\x0a' \
  ;
 end

diff --git a/shell/shellIntegration.nu b/shell/shellIntegration.nu
@@ -1,4 +1,4 @@
-let __is_escape_value = {|x| $x | str replace --all "\\" "\\\\" | str replace --all ";" "\\x3b" | str replace --all "\n" '\x0a' | str replace --all "\e" "\\x1b" }
+let __is_escape_value = {|x| $x | str replace --all "\\" "\\\\" | str replace --all ";" "\\x3b" | str replace --all "\n" '\x0a' | str replace --all "\e" "\\x1b" | str replace --all "\a" "\\x07" }
 let __is_original_PROMPT_COMMAND = if 'PROMPT_COMMAND' in $env { $env.PROMPT_COMMAND } else { "" }
 let __is_original_PROMPT_INDICATOR = if 'PROMPT_INDICATOR' in $env { $env.PROMPT_INDICATOR } else { "" }
 

diff --git a/shell/shellIntegration.ps1 b/shell/shellIntegration.ps1
@@ -8,7 +8,7 @@ if ($env:ISTERM_TESTING -eq "1") {
 }
 
 function Global:__IS-Escape-Value([string]$value) {
- [regex]::Replace($value, "[$([char]0x1b)\\\n;]", { param($match)
+ [regex]::Replace($value, "[$([char]0x1b)$([char]0x07)\\\n;]", { param($match)
  -Join (
  [System.Text.Encoding]::UTF8.GetBytes($match.Value) | ForEach-Object { '\x{0:x2}' -f $_ }
  )

diff --git a/shell/shellIntegration.xsh b/shell/shellIntegration.xsh
@@ -12,7 +12,7 @@ def __is_escape_value(value: str) -> str:
  byte_list = [bytes([byte]).decode("utf-8") for byte in list(value.encode("utf-8"))]
  return "".join(
  [
- "\\x3b" if byte == ";" else "\\\\" if byte == "\\" else "\\x1b" if byte == "\x1b" else "\x0a" if byte == "\n" else byte
+ "\\x3b" if byte == ";" else "\\\\" if byte == "\\" else "\\x1b" if byte == "\x1b" else "\x0a" if byte == "\n"else "\\x07" if byte == "\x07" else byte
  for byte in byte_list
  ]
  )

diff --git a/src/isterm/commandManager.ts b/src/isterm/commandManager.ts
@@ -188,9 +188,7 @@ export class CommandManager {
  const italic = (cell?.isItalic() ?? 0) > 0;
  const dullColor = color == 8 || color == 7 || (color ?? 0) > 235 || (color == 15 && dim);
  const dimItalic = dim || italic;
- if (this.#shell == Shell.Powershell) {
- return false;
- } else if (this.#shell == Shell.Pwsh) {
+ if (this.#shell == Shell.Pwsh || this.#shell == Shell.Powershell) {
  return dimItalic;
  }
  return dullColor;

diff --git a/src/isterm/pty.ts b/src/isterm/pty.ts
@@ -111,7 +111,9 @@ export class ISTerm implements IPty {
  }
 
  private _sanitizedPrompt(prompt: string): string {
- return stripAnsi(prompt);
+ // eslint-disable-next-line no-control-regex -- strip OSC control sequences
+ const oscStrippedPrompt = prompt.replace(/\x1b\][0-9]+;.*\x07/g, "");
+ return stripAnsi(oscStrippedPrompt);
  }
 
  private _handleIsSequence(data: string): boolean {