Handle env vars in a case-preserving, case-insensitive manner on Windows #574
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
|
@niik Just making sure you were aware of the failing tests (I have been putting off reviewing till those are happy) |
I was not aware, thanks for the heads up! |
sergiou87
reviewed
Oct 21, 2024
test/fast/environment-test.ts
Outdated
| @@ -53,11 +53,20 @@ describe('environment variables', () => { | |||
| // case-insensitive (like Windows) we don't end up with an invalid PATH | |||
| // and the original one lost in the process. | |||
| const { env } = setupEnvironment({}) | |||
| expect(env.PATH).toContain('wow-such-case-insensitivity') | |||
| expect(env.Path).toContain('wow-such-case-insensitivity') | |||
There was a problem hiding this comment.
Shouldn't this be checking PATH to prove it's case insensitive? 🤔 Or both…
There was a problem hiding this comment.
Oh boy, this was 5 months ago but I think this is correct albeit highly confusing. It's meant to test that on Windows the env map is case preserving but case insensitive. That said I tried to update the test to be more clear and found a bug in EnvMap's constructor. Happy for you to take another look now!
sergiou87
approved these changes
Oct 21, 2024
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 a follow-up to #570 and attempts to tackle Windows environment variable shenanigans for all environment variables and not just
PATH. The main change is the introduction ofEnvMap, a class that behaves as a case-insensitive, case-preserving map on Windows and a regular case-sensitive map on other platforms. This class is used inlib/git-environment.tsto handle environment variables in a consistent manner across platforms.I've also bumped Prettier to 3.3.1 so it can handle my syntax and specified the version of TypeScript used by Visual Studio Code in
.vscode/settings.jsonbecause I was building this on an old VM with an old VS code and noticed that it wouldn't complete properly.