fix(informative-docs): trim description text

gajus · Apr 24, 2023 · f3faa25 · f3faa25
1 parent 597e255
commit f3faa25
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7649,6 +7649,13 @@ function takesOne(param) {}
  * takes abc param
  */
 function takesOne(param) {}
+
+/**
+ * @class 
+ *
+ * @param {number} value - Some useful text
+ */      
+function MyAmazingThing(value) {}
 ````
 
 

diff --git a/src/rules/informativeDocs.js b/src/rules/informativeDocs.js
@@ -70,7 +70,8 @@ export default iterateJsdoc(({
   const nodeNames = getNamesFromNode(node);
 
   const descriptionIsRedundant = (text, extraName = '') => {
-    return Boolean(text) && !areDocsInformative(text, [
+    const textTrimmed = text.trim();
+    return Boolean(textTrimmed) && !areDocsInformative(textTrimmed, [
       extraName, nodeNames,
     ].filter(Boolean).join(' '), {
       aliases,

diff --git a/test/rules/assertions/informativeDocs.js b/test/rules/assertions/informativeDocs.js
@@ -749,5 +749,15 @@ export default {
         function takesOne(param) {}
       `,
     },
+    {
+      code: `
+        /**
+         * @class 
+         *
+         * @param {number} value - Some useful text
+         */      
+        function MyAmazingThing(value) {}
+      `,
+    },
   ],
 };