Allow escaping "$" in command arguments #505
Open
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
The `sh.Exec` family of functions used to use `os.Expand` to expand environment variables in command arguments, but that function offers no escape syntax -- no way to avoid expanding dollar signs that the caller really wants to include on the command line. This commit implements a new, mostly compatible `Expand` function to allow escaping the environment-variable syntax, plus an accompanying `Escape` function to producing escaped strings. This technically breaks backward compatibility; any existing code that has used the sequence "\\" or "\$" in its command arguments will need to be updated. Although the compatibility argument prevents `os.Expand` from changing, documentation for `sh.Exec` hasn't actually stated that it follows all the same rules as `os.Expand`, so it's possible to view this change as merely a bugfix, formalizing a new syntax that had not previously been established. Fixes magefile#434
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.
The
sh.Execfamily of functions used to useos.Expandto expand environment variables in command arguments, but that function offers no escape syntax — no way to avoid expanding dollar signs that the caller really wants to include on the command line. This commit implements a new, mostly compatibleExpandfunction to allow escaping the environment-variable syntax, plus an accompanyingEscapefunction to producing escaped strings.This technically breaks backward compatibility; any existing code that has used the sequences "\\" or "\$" in its command arguments will need to be updated. Although the compatibility argument prevents
os.Expandfrom changing, documentation forsh.Exechasn't actually stated that it follows all the same rules asos.Expand, so it's possible to view this change as merely a bugfix, formalizing a new syntax that had not previously been established.Fixes #434