fix(require-description-complete-sentence): regression re: not trim…

…ming of description for check as relevant to tag description checking; fixes #672
gajus · Jan 14, 2021 · d81caa2 · d81caa2
1 parent 9f69c36
commit d81caa2
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8383,6 +8383,15 @@ function quux () {
  */
 function speak() {
 }
+
+/**
+ * @param foo
+ *
+ * @returns {void}
+ */
+export default (foo) => {
+  foo()
+}
 ````
 
 

diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -190,7 +190,7 @@ export default iterateJsdoc(({
   });
 
   tagsWithNames.some((tag) => {
-    const desc = _.trimStart(tag.description, '- ');
+    const desc = _.trimStart(tag.description, '- ').trimEnd();
 
     return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
   });

diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -1353,5 +1353,20 @@ export default {
       }
       `,
     },
+    {
+      code: `
+      /**
+       * @param foo
+       *
+       * @returns {void}
+       */
+      export default (foo) => {
+        foo()
+      }
+      `,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
 };