fix(match-description): while preserving internal newlines, ensure …

…trailing whitespace is stripped for comparisons; for #692
gajus · Feb 16, 2021 · 27b95b3 · 27b95b3
1 parent d682f1f
commit 27b95b3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/src/rules/matchDescription.js b/src/rules/matchDescription.js
@@ -45,7 +45,7 @@ export default iterateJsdoc(({
   if (jsdoc.description) {
     const {description} = utils.getDescription();
     validateDescription(
-      description.replace(/\n+$/, ''),
+      description.replace(/\s+$/, ''),
     );
   }
 

diff --git a/test/rules/assertions/matchDescription.js b/test/rules/assertions/matchDescription.js
@@ -1339,5 +1339,17 @@ export default {
         },
       }],
     },
+
+    // https://github.com/gajus/eslint-plugin-jsdoc/issues/692#issuecomment-780081285
+    {
+      code: `
+      /** Wrap attributes threshold. */
+      const quux = {};
+      `,
+      ignoreReadme: true,
+      options: [{
+        contexts: ['any'],
+      }],
+    },
   ],
 };