fix(newline-after-description): avoid matching duplicate or partial m…

…atches within tag descriptions after the block description; fixes #328
gajus · Jul 12, 2019 · c7f79fa · c7f79fa
1 parent 87110ed
commit c7f79fa
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 2 deletions.
diff --git a/src/rules/newlineAfterDescription.js b/src/rules/newlineAfterDescription.js
@@ -30,7 +30,7 @@ export default iterateJsdoc(({
     if (!descriptionEndsWithANewline) {
       const sourceLines = sourceCode.getText(jsdocNode).split('\n');
       const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
-        return line.includes(_.last(jsdoc.description.split('\n')));
+        return line.replace(/^\s*\*\s*/, '') === _.last(jsdoc.description.split('\n'));
       });
       report('There must be a newline after the description of the JSDoc block.', (fixer) => {
         // Add the new line
@@ -44,7 +44,7 @@ export default iterateJsdoc(({
   } else if (descriptionEndsWithANewline) {
     const sourceLines = sourceCode.getText(jsdocNode).split('\n');
     const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
-      return line.includes(_.last(jsdoc.description.split('\n')));
+      return line.replace(/^\s*\*\s*/, '') === _.last(jsdoc.description.split('\n'));
     });
     report('There must be no newline after the description of the JSDoc block.', (fixer) => {
       // Remove the extra line

diff --git a/test/rules/assertions/newlineAfterDescription.js b/test/rules/assertions/newlineAfterDescription.js
@@ -98,6 +98,56 @@ export default {
 
           }
       `
+    },
+    {
+      code: `
+        /**
+         * A.
+         *
+         * @typedef {Object} A
+         * @prop {boolean} a A.
+         */
+      `,
+      errors: [
+        {
+          message: 'There must be no newline after the description of the JSDoc block.'
+        }
+      ],
+      options: [
+        'never'
+      ],
+      output: `
+        /**
+         * A.
+         * @typedef {Object} A
+         * @prop {boolean} a A.
+         */
+      `
+    },
+    {
+      code: `
+        /**
+         * A.
+         * @typedef {Object} A
+         * @prop {boolean} a A.
+         */
+      `,
+      errors: [
+        {
+          message: 'There must be a newline after the description of the JSDoc block.'
+        }
+      ],
+      options: [
+        'always'
+      ],
+      output: `
+        /**
+         * A.
+         *
+         * @typedef {Object} A
+         * @prop {boolean} a A.
+         */
+      `
     }
   ],
   valid: [