cli: escape chalk parentheses #612
Merged
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
This was referenced Jul 31, 2018
aomarks
reviewed
Aug 27, 2018
packages/cli/src/commands/lint.ts
Outdated
| {header: 'Lint Rules', content: rulesDocs.join('\n\n'), raw: true} | ||
| { | ||
| header: 'Lint Rules', | ||
| content: rulesDocs.join('\n\n').replace(/[{}\\]/g, '\\$&'), |
There was a problem hiding this comment.
Can you add a comment to explain this?
|
Also a CHANGELOG entry please |
|
@aomarks thanks for taking a look at this, much appreciated. have updated the changelog and added a small comment now |
aomarks
approved these changes
Aug 28, 2018
This was referenced Sep 14, 2020
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.
So this seems to fix #595.
The underlying issue here is that command-line-usage uses chalk 2.x (we use chalk 1.x) which makes heavy use of template literals and introduces a curly-bracket syntax like so:
When we pass our help text to command-line-usage, it isn't escaped (because they forcefully pass it to chalk as "raw" text which chalk doesn't escape). So our parentheses are interpreted as chalk's syntax.
Internally, chalk escapes parentheses with the exact regex i've added here.
I'm not sure if i like this fix... because this could easily occur in other places where we pass arbitrary text into chalk. Any ideas how we can generalise this a little more? Or if we need to?