Add test coverage for optional backtick prior to flags for PowerShell#2458
Open
ericcornelissen wants to merge 14 commits intomainfrom
Open
Add test coverage for optional backtick prior to flags for PowerShell#2458ericcornelissen wants to merge 14 commits intomainfrom
ericcornelissen wants to merge 14 commits intomainfrom
Conversation
Because when escaping the backtick is escaped and thus preserved in the output and when quoting the backtick has no effect (it is not otherwise escaped either).
ericcornelissen
commented
Apr 4, 2026
Re-implement the internal logic for the flag protection functionality.
At a high level, the old implementation is removed and a new one is
implemented instead. The reason for removing the old implementation is
that it was fundamentally flawed because of a circular relation between
escaping and flag protection: escaping might change the input string
such that flag protection is necessary and flag protection may change
the result of escaping because it changes the input string. This buggy
behavior is (hopefully) fixed and has been recorded in the changelog.
To address this the "flagProtection" function has been replaced by
a function that splits the provided argument into flag-prefix and
non-flag-prefix parts and escapes and prunes the argument prefix
iteratively [^1] until there are no more empty-after-escaping or
flag-prefixes left, at which point the remaining string is escaped
(and quoted, if necessary).
This also fixes a bug with flag protection that did not require the
full rewriting, namely that on Windows a prefix combining `-` and `/`
would always leave one or the other, thus leaving flags behind. This bug
has been recorded separately in the changelog.
This _finally_ makes the dream of having flag protection be a platform
(rather than shell) level things be a reality!
This change is accompanied by a ton of changes to the test suite that
should increase the confidence in the change and new behavior. First and
foremost, as this change was triggered by a problem with flag protection
on Windows, the test fixtures for windows have been significantly
extended focussing on flag-related character (`-` and `/`) and their
combination. The changes to the `index.test.js` unit suites is just as
a result of lifting the flag protection from the shell to the platform
level. The `shells.test.js` similarly have most test related to flag
protection removed but did get back tests for the composition of flag
protection with the shell specific escaping and quoting logic. Notably,
this expands the testing of flag protection beyond fixtures into
property tests (testing the metamorphic property that adding a flag
prefix to an argument does not affect how the argument is escaped
compared to escaping the argument itself).
Lastly, this reverts some temporary changes intended for testing Windows
stuff in CI.
---
[^1]: See the `pathological strings` fixtures for example of why this is
necessary.
ericcornelissen
commented
Apr 5, 2026
ericcornelissen
commented
Apr 5, 2026
- Revert temporary change. - Remove use of `||=`. - Fix uncaught mutant (`(arg) => [arg]` -> `(arg) => []`).
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Caution Review failedAn error occurred during the review process. Please try again later. WalkthroughThis change refactors flag protection handling by introducing a shared Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #2014
Relates to #908, #2036, #2436 (comment)