fix escaping for terminal completions for zsh/bash/fish #251989
+105
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Working on pwsh now |
meganrogge
changed the title
|
Just realized maybe we want to handle escaping where this gets inserted instead of changing the label? Yes, going with that instead |
|
something weird is happening w pwsh . It gets escaped properly and sent to the terminal, but then the inserted text is wrong 
|
|
pwsh seems involved, skipping for now |
meganrogge
changed the title
Tyriar
requested changes
Jun 20, 2025
src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalCompletionService.ts
Outdated
Show resolved
Hide resolved
src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalCompletionEscapeHelper.ts
Outdated
Show resolved
Hide resolved
meganrogge
force-pushed
the
scornful-hoverfly
branch
from
6d9c5e5 to
6cd435c
Compare
Tyriar
requested changes
Jun 20, 2025
src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalCompletionService.ts
Outdated
Show resolved
Hide resolved
|
I manually tested each to make sure it's necessary @Tyriar and added tests too. |
|
@Tyriar could you pls review? |
Tyriar
requested changes
Jun 25, 2025
| export function escapeTerminalCompletionLabel(label: string, shellType: TerminalShellType, pathSeparator: string): string { | ||
| // Only escape for bash/zsh/fish; PowerShell and cmd have different rules | ||
| if (shellType === GeneralShellType.PowerShell || shellType === WindowsShellType.CommandPrompt) { | ||
| // TODO: Implement escaping for PowerShell/cmd if needed |
There was a problem hiding this comment.
Let's remove unless it's needed?
Comment on lines
+577
to
+582
| const specialCharsSet = new Set(['[', ']', '(', ')', '\'', '"', '\\', '`', '*', '?', ';', '&', '|', '<', '>']); | ||
| const specialCharsRegex = /[\[\]\(\)'"\\\`\*\?;|&<>]/; | ||
| if (!specialCharsRegex.test(label)) { | ||
| return label; | ||
| } | ||
| return label.split('').map(c => specialCharsSet.has(c) ? '\\' + c : c).join(''); |
There was a problem hiding this comment.
Can simplify and use just regex:
input.replace(/[\[\]\(\)'"\\\`\*\?;|&<>]/g, '\\$&');
Comment on lines
+405
to
+407
| if (shellType) { | ||
| label = escapeTerminalCompletionLabel(label, shellType, resourceRequestConfig.pathSeparator); | ||
| } |
There was a problem hiding this comment.
nit: Could move the if into the escape function and allow it to accept shellType undefined to simplify this function a little
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #249024