fix(newline-after-description): avoid erring on encountering sequen…

…ce of carriage returns (or other non-whitespace) as sole content of jsdoc block description (fixes #433)
gajus · Nov 19, 2019 · e453b2d · e453b2d
1 parent a38b28b
commit e453b2d
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4350,6 +4350,20 @@ function quux () {
 // Options: ["never"]
 // Message: There must be no newline after the description of the JSDoc block.
 
+
+         /**
+          * Bar.
+          *
+          * Bar.
+          *
+          * @bar
+          */
+         function quux () {
+
+         }
+// Options: ["never"]
+// Message: There must be no newline after the description of the JSDoc block.
+
 /**
  * A.
  *
@@ -4415,6 +4429,23 @@ function quux () {
 
 }
 // Options: ["never"]
+
+
+     /**
+      * @foo
+      * Test 
+      * abc 
+      * @bar 
+      */
+
+
+     /**
+      * 
+      * @foo
+      * Test 
+      * abc 
+      * @bar 
+      */
 ````
 
 

diff --git a/src/rules/newlineAfterDescription.js b/src/rules/newlineAfterDescription.js
@@ -11,7 +11,7 @@ export default iterateJsdoc(({
 }) => {
   let always;
 
-  if (!jsdoc.description || !jsdoc.tags.length) {
+  if (!jsdoc.description.trim() || !jsdoc.tags.length) {
     return;
   }
 

diff --git a/test/rules/assertions/newlineAfterDescription.js b/test/rules/assertions/newlineAfterDescription.js
@@ -99,6 +99,40 @@ export default {
           }
       `,
     },
+    {
+      code: `\r
+          /**\r
+           * Bar.\r
+           *\r
+           * Bar.\r
+           *\r
+           * @bar\r
+           */\r
+          function quux () {\r
+\r
+          }\r
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'There must be no newline after the description of the JSDoc block.',
+        },
+      ],
+      options: [
+        'never',
+      ],
+      output: `\r
+          /**\r
+           * Bar.\r
+           *\r
+           * Bar.\r
+           * @bar\r
+           */\r
+          function quux () {\r
+\r
+          }\r
+      `,
+    },
     {
       code: `
         /**
@@ -232,5 +266,26 @@ export default {
         'never',
       ],
     },
+    {
+      code: `\r
+      /**\r
+       * @foo\r
+       * Test\u00a0\r
+       * abc\u00a0\r
+       * @bar\u00a0\r
+       */\r
+      `,
+    },
+    {
+      code: `\r
+      /**\r
+       * \r
+       * @foo\r
+       * Test\u00a0\r
+       * abc\u00a0\r
+       * @bar\u00a0\r
+       */\r
+      `,
+    },
   ],
 };