Merge pull request #612 from 43081j/lint-help

cli: escape chalk parentheses
Polymer · Aug 28, 2018 · bf6b449 · bf6b449
2 parents c64bfa1 + 6fe0320
commit bf6b449
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,7 +1,8 @@
 # Changelog
 
-<!-- ## Unreleased -->
-<!-- Add new, unreleased items here. -->
+## Unreleased
+* Fix an issue where we were passing lint rule help text through chalk
+  with unescaped chalk-specific syntax, causing chalk parsing errors.
 
 ## v1.8.0 [08-15-2018]
 * Fix a case where the CustomElementsEs5Adapter script was not added to the 

diff --git a/packages/cli/src/commands/lint.ts b/packages/cli/src/commands/lint.ts
@@ -128,7 +128,15 @@ export class LintCommand implements Command {
         content: collectionsDocs.join('\n\n'),
         raw: true
       },
-      {header: 'Lint Rules', content: rulesDocs.join('\n\n'), raw: true}
+      {
+        header: 'Lint Rules',
+        // Here we replace special characters with chalk's escape
+        // syntax (`\$&`) to avoid chalk trying to re-process our input.
+        // This is needed because chalk supports a form of `{var}`
+        // interpolation.
+        content: rulesDocs.join('\n\n').replace(/[{}\\]/g, '\\$&'),
+        raw: true
+      }
     ];
   }