JSDoc rule should not block arbitrary comments like /********/ (#1543)

palantir · Sep 10, 2016 · e9bedf9 · e9bedf9
1 parent eca8ac7
commit e9bedf9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/rules/jsdocFormatRule.ts b/src/rules/jsdocFormatRule.ts
@@ -76,8 +76,8 @@ class JsdocWalker extends Lint.SkippableTokenAwareRuleWalker {
         const firstLine = lines[0];
         let jsdocPosition = currentPosition;
 
-        // regex is: start of string, followed by any amount of whitespace, followed by /**
-        const isJsdocMatch = firstLine.match(/^\s*\/\*\*/);
+        // regex is: start of string, followed by any amount of whitespace, followed by /** but not more than 2 **
+        const isJsdocMatch = firstLine.match(/^\s*\/\*\*([^*]|$)/);
         if (isJsdocMatch != null) {
             if (lines.length === 1) {
                 const firstLineMatch = firstLine.match(/^\s*\/\*\* (.* )?\*\/$/);

diff --git a/test/rules/jsdoc-format/jsdoc.ts.lint b/test/rules/jsdoc-format/jsdoc.ts.lint
@@ -23,6 +23,10 @@ I've even got characters where I shouldn't. How fun!    *
          */
     }
 
+    /**********************************************************/
+    /* this is just an arbitrary separator, not a jsdoc block */
+    /**********************************************************/
+
     /**
      * this is also jsdoc
      *and it has a problem on this line