Powershell: Delimit envrionment variable names when setting #1255
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
Without this many exports, such as `$env:'depsBuildTargetPropagated'='';`,
are not valid Powershell and result in an error being thrown:
```
Invoke-Expression -Command $export;
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Variable reference is not valid. ':' was not followed by a valid
| variable name character. Consider using ${} to delimit the name
```
The quotes around escaped variable names cause Powershell to be confused
because it can't figure out what is part of the variable reference. So just
delimit the name to make it clear what's part of the name and what's part
of the value.
|
@BlackHoleFox I thought there was a PR check to run tests, but that doesn't appear to be true. Did you run the PowerShell test suite to confirm they still pass? |
bamsammich
suggested changes
Jun 3, 2024
There was a problem hiding this comment.
After testing this a bit, we didn't get the expected behavior with this change. The problem exists in escaping the key, meaning that this change will set ${env:'key'}=value literally in the environment, including quotes.
To fix this, you must comb through the escape cases to find the proper method for escaping environment variable names/keys.
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 is the simplest fix for the problem outlined in #1254: It just uses a brace pattern to delimit what the environment variable name key should be regardless of how
keyneeds escaped. This lets it determine that the escape quotes are only for key instantiation.With this patch
cding in and out of my project directory works exactly like I'd expect and has no errors.There might be another fix, like stripping unnecessary quoting, but this seems more robust and like it will work in more cases. I don't know how to write a test for this specific issue though since I'm unsure of how to minimize a Nix flake's output into
direnv's test case definitions. If regression tests are wanted, help is appreciated please :)cc @bamsammich as the original PowerShell support implementer
Closes #1254