docs: highlight double quoting issue #1164
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR addresses a quoting issue by adding a test case to simulate broken quoting and updating documentation to warn users about potential unsafe injection due to double quoting.
- Added a test case ("broken quoting") in test/core.test.js to capture unexpected output with mixed quoting.
- Updated docs/quotes.md with a warning block that highlights the risk of unsafe injection when using additional quotes.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/core.test.js | Introduces a test case demonstrating issues with broken quoting. |
| docs/quotes.md | Enhances documentation with a warning about unsafe injection. |
Comments suppressed due to low confidence (2)
test/core.test.js:105
- [nitpick] Consider renaming the test to more explicitly describe the expected failure scenario or behavior for clarity.
test('broken quoting', async () => {
test/core.test.js:107
- Using mixed shell quoting syntax here may lead to unexpected behavior in environments with different shell quoting rules. Consider confirming that the intended behavior is reliable across systems or adjusting the quoting method for clarity.
const p = $`echo --foo=$'${args}'`
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.
Uh oh!
There was an error while loading. Please reload this page.