Escape quotes in arguments for PowerShell #319
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
sindresorhus
reviewed
Aug 9, 2023
index.js
Outdated
| @@ -202,7 +202,7 @@ const baseOpen = async options => { | |||
| } | |||
|
|
|||
| if (appArguments.length > 0) { | |||
| appArguments = appArguments.map(arg => `"\`"${arg}\`""`); | |||
| appArguments = appArguments.map(arg => `"\`"${String.prototype.replaceAll.call(arg, '"', '`"')}\`""`); | |||
There was a problem hiding this comment.
Suggested change
| appArguments = appArguments.map(arg => `"\`"${String.prototype.replaceAll.call(arg, '"', '`"')}\`""`); | |
| appArguments = appArguments.map(arg => `"\`"${String(arg).replaceAll('"', '`"')}\`""`); |
There was a problem hiding this comment.
This does not handle the case where the quote is already escaped: \"
There was a problem hiding this comment.
Sorry for the late response. Could you please elaborate on the \" escaping? I can't find anything on using \ as an escape character in PowerShell.
Alternatively, would it make sense to use single quote strings, as they don't interpret special characters? You can include single quotes in single quote strings by doubling them. This would almost certainly eliminate any edge cases.
First convert to string and then call replaceAll, instead of calling replaceAll from the string prototype Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
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.
A fix for #318. This is just a simple patch and can of course be changed if necessary.
The
String.prototype.replaceAll.call(arg, ...)instead of justarg.replaceAll(...)is becauseappArgumentsmight contain things other than strings.This doesn't add escaping to the app name itself.
I'm not sure if you want to set up a unit test for this scenario, and I'm not sure if this change marks a breaking API change (if some people already put
`in their strings even though that wouldn't work on other platforms).