Support pwsh format for show-env export #411
Open
+101
−8
Conversation
This file contains 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
| /// Prepend "export " to each line, so that the output is suitable to be sourced by bash. | ||
| pub(crate) export_prefix: bool, | ||
| UnixExport, | ||
| /// Each value: "$env:{key}=@'\n{}\n", escaped using [`shell_escape::escape`]. |
There was a problem hiding this comment.
Stale comment needs to be fixed
asvrada
reviewed
Jan 3, 2025
| @@ -8,6 +8,10 @@ OPTIONS: | |||
| --export-prefix | |||
| Prepend "export " to each line, so that the output is suitable to be sourced by bash | |||
|
|
|||
| --export-pwsh-prefix | |||
| Unicode escape and double quote values + prepend "$env:", so that the output is suitable | |||
| to be used with Invoke-Expression in pwsh. | |||
There was a problem hiding this comment.
Could you change in pwsh to in PowerShell?
|
Thanks for this! Confirmed reading as Unicode doesn't work with PowerShell Version 5.1. But works after v6.0.0.0 Other than that, it looks good. |
asvrada
approved these changes
Jan 5, 2025
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.
This PR demonstrates a solution for #395, with a slightly different strategy that what was discussed.
The issues outlined there:
CARGO_ENCODED_RUSTFLAGStake non-printable characters that unix shells will accept but pwsh won't.Additionally, the shell escape crate used is escaping for cmd, not pwsh and wouldn't be compatible.
Pwsh does accept embedded unicode codes in strings though. If we encode the values this way, we don't need to worry about printable vs non-printable characters nor any of the specifics for what kinds of characters need to be escaped for what kinds of strings. This is a one-time, very fast operation. Once the emitted string is executed all the escapes are gone.
This approach wouldn't be good for a general-purpose escape function, but it's perfectly suitable for this use case.
The change enables users to execute a pwsh version of the source demo:
Primary goal was to confirm this approach worked. If this is of interest, I can make any changes to the code organization, arg name, etc. The current organization is just what came to mind as I played around with the repo.
Manual test context with binary data in env:
Intermediate state example:
Final result:
