Breaking: Remove all tokens inside comments from tokens array (fixes #422) (#423)

Author: kaicataldo

lib/node-utils.js

@@ -187,7 +187,9 @@ module.exports = {
     convertTokens,
     getNodeContainer,
     isWithinTypeAnnotation,
-    isTypeKeyword
+    isTypeKeyword,
+    isComment,
+    isJSDocComment
 };
 /* eslint-enable no-use-before-define */
 
@@ -246,6 +248,24 @@ function isComma(token) {
     return token.kind === SyntaxKind.CommaToken;
 }
 
+/**
+ * Returns true if the given TSNode is a comment
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} is commment
+ */
+function isComment(node) {
+    return node.kind === SyntaxKind.SingleLineCommentTrivia || node.kind === SyntaxKind.MultiLineCommentTrivia;
+}
+
+/**
+ * Returns true if the given TSNode is a JSDoc comment
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} is JSDoc comment
+ */
+function isJSDocComment(node) {
+    return node.kind === SyntaxKind.JSDocComment;
+}
+
 /**
  * Returns the binary expression type of the given TSToken
  * @param  {TSToken} operator the operator token
@@ -258,7 +278,6 @@ function getBinaryExpressionType(operator) {
         return "LogicalExpression";
     }
     return "BinaryExpression";
-
 }
 
 /**
@@ -695,6 +714,12 @@ function convertTokens(ast) {
      * @returns {undefined}
      */
     function walk(node) {
+        // TypeScript generates tokens for types in JSDoc blocks. Comment tokens
+        // and their children should not be walked or added to the resulting tokens list.
+        if (isComment(node) || isJSDocComment(node)) {
+            return;
+        }
+
         if (isToken(node) && node.kind !== SyntaxKind.EndOfFileToken) {
             const converted = convertToken(node, ast);
 

tests/fixtures/comments/jsdoc-comment.src.js

@@ -0,0 +1,8 @@
+/**
+ * This is a function.
+ * @param {String} bar some string
+ * @returns {String} returns bar
+ */
+function foo(bar) {
+    return bar;
+}

tests/integration/external-fixtures/jsdoc-indent.js

@@ -9,4 +9,13 @@ foo;
 /**
  * a
  */
-foo;
+foo;
+
+/**
+ * This is a function.
+ * @param {String} bar some string
+ * @returns {String} returns bar
+ */
+function foo(bar) {
+    return bar;
+}

tests/integration/typescript.spec.js

@@ -80,7 +80,7 @@ describe("TypeScript", () => {
         );
     });
 
-    it("should not produce any lint errors on valid JSDoc indentation (#344)", () => {
+    it("should not produce any lint errors on valid JSDoc indentation (#344 & #422)", () => {
         verifyAndAssertMessages(
             loadExternalFixture("jsdoc-indent"),
             {