Correctly escape strings inserted into RegExps

Fixes: gajus#62
cscott · Feb 27, 2018 · 8f10f2b · 8f10f2b
1 parent 647dc04
commit 8f10f2b
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -63,7 +63,7 @@ const validateDescription = (description, report, jsdocNode, sourceCode, tag) =>
  if (!/[.:?!]$/.test(paragraph)) {
  const line = _.last(paragraph.split('\n'));
 
- text = text.replace(new RegExp(line + '$', 'm'), line + '.');
+ text = text.replace(new RegExp(_.escapeRegExp(line) + '$', 'm'), line + '.');
  }
 
  for (const sentence of sentences.filter((sentence_) => {
@@ -72,7 +72,7 @@ const validateDescription = (description, report, jsdocNode, sourceCode, tag) =>
  const beginning = sentence.split('\n')[0];
 
  if (tag) {
- const reg = new RegExp('(@' + tag + '.*)' + _.escapeRegExp(beginning));
+ const reg = new RegExp('(@' + _.escapeRegExp(tag) + '.*)' + _.escapeRegExp(beginning));
 
  text = text.replace(reg, ($0, $1) => {
  return $1 + capitalize(beginning);

diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -25,6 +25,29 @@ export default {
  }
  `
  },
+ {
+ code: `
+ /**
+ * Foo)
+ */
+ function quux () {
+
+ }
+ `,
+ errors: [
+ {
+ message: 'Sentence must end with a period.'
+ }
+ ],
+ output: `
+ /**
+ * Foo).
+ */
+ function quux () {
+
+ }
+ `
+ },
  {
  code: `
  /**