shellIntegration.ps1: escape values in "E" (executed command) and "P" (property KV) codes #165634
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
This was referenced Nov 6, 2022
shellIntegration-rc.zsh: escape values in "E" (executed command) and "P" (property KV) codes
#165633
Merged
Merged
rwe
force-pushed
the
serialize-message-ps1
branch
from
13319aa to
c98f04f
Compare
rwe
force-pushed
the
serialize-message-ps1
branch
2 times, most recently
from
7a0df67 to
c69c606
Compare
|
I'm seeing this when running recent command when I fix conflicts and test:
|
|
For this:
Here's the string we get: |
|
|
Tyriar
requested changes
Nov 23, 2022
src/vs/workbench/contrib/terminal/browser/media/shellIntegration.ps1
Outdated
Show resolved
Hide resolved
Instead of only escaping '\', '', and ';', all non-alphanumeric values are escaped. Backslashes are doubld and other characters are encoded as hex. The previous version would pass invalid characters through unescaped, including OSC sequences. Although that no longer is allowed, this iteration does not yet enforce particular (e.g. utf-8) encoding and will still misbehave on multibyte sequences.
rwe
force-pushed
the
serialize-message-ps1
branch
from
ef00b33 to
91f0eae
Compare
connor4312
approved these changes
Nov 23, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This implements the string escaping scheme documented for the "E" (executed) and "P" (property KV) codes. This is "pure"
zshand relies on no external utilities.Although currently the only "required" escapes are backslash, semicolon,
\a, and perhaps newlines, this conservatively escapes all non-alphanumeric characters.Backslashes are doubled, non-alphanumerics are hex-escaped.
Sibling to:
deserializeMessage()implementation + add tests #165635Relates to or resolves parts of:
Caveat
Unaddressed here, but more plain to see than in the other shells, is that the encoding of multibyte codepoints is not currently well-defined by the escaping scheme. This chooses to encode as UTF-8 in order to make them byte-representable at all. Regardless,
shellIntegrationAddon.tsseverely mishandles the interpretation of escapes anyway, even in the ASCII range, so the point is slightly moot.