fix(newline-after-description): only treat comments with whitespace…

… after two asterisks only as jsdoc Per jsdoc spec at https://jsdoc.app/about-getting-started.html : > Each comment must start with a /** sequence in order to be recognized by the JSDoc parser. Comments beginning with /*, /***, or more than 3 stars will be ignored.
gajus · Nov 20, 2019 · 3d61126 · 3d61126
1 parent e453b2d
commit 3d61126
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1111,7 +1111,7 @@ report a padding issue:
 The following patterns are considered problems:
 
 ````js
-/***  foo */
+/**  foo */
 function quux () {
 
 }
@@ -4446,6 +4446,14 @@ function quux () {
       * abc 
       * @bar 
       */
+
+/***
+ *
+ */
+function quux () {
+
+}
+// Options: ["always"]
 ````
 
 

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -431,7 +431,7 @@ const iterateAllJsdocs = (iterator, ruleConfig) => {
           const comments = sourceCode.getAllComments();
 
           comments.forEach((comment) => {
-            if (!sourceCode.getText(comment).startsWith('/**')) {
+            if (!(/\/\*\*\s/).test(sourceCode.getText(comment))) {
               return;
             }
 

diff --git a/test/rules/assertions/checkIndentation.js b/test/rules/assertions/checkIndentation.js
@@ -2,7 +2,7 @@ export default {
   invalid: [
     {
       code: `
-          /***  foo */
+          /**  foo */
           function quux () {
 
           }

diff --git a/test/rules/assertions/newlineAfterDescription.js b/test/rules/assertions/newlineAfterDescription.js
@@ -287,5 +287,17 @@ export default {
        */\r
       `,
     },
+    {
+      code: `
+      /***
+       *
+       */
+      function quux () {
+
+      }`,
+      options: [
+        'always',
+      ],
+    },
   ],
 };