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

Author: Kai Cataldo

lib/node-utils.js

@@ -244,6 +244,32 @@ function isComma(token) {
     return token.kind === SyntaxKind.CommaToken;
 }
 
+/**
+ * Returns true if the given TSToken is a comment
+ * @param  {TSToken}  token the TypeScript token
+ * @returns {boolean}       is commment
+ */
+function isComment(token) {
+    return (token.kind === SyntaxKind.SingleLineCommentTrivia || token.kind === SyntaxKind.MultiLineCommentTrivia) || (token.kind >= SyntaxKind.JSDocTypeExpression && token.kind <= SyntaxKind.JSDocTypeLiteral);
+}
+
+/**
+ * Returns true if the given TSToken is inside a comment
+ * Non-comment type tokens are generated for types in JSDoc Blocks
+ * @param  {TSToken}  token the TypeScript token
+ * @returns {boolean}       is inside a commment
+ */
+function isInsideComment(token) {
+    if (token.kind === SyntaxKind.SourceFile) {
+        return false;
+    }
+    if (isComment(token)) {
+        return true;
+    }
+    return isInsideComment(token.parent);
+}
+
+
 /**
  * Returns the binary expression type of the given TSToken
  * @param  {TSToken} operator the operator token
@@ -693,7 +719,7 @@ function convertTokens(ast) {
      * @returns {undefined}
      */
     function walk(node) {
-        if (isToken(node) && node.kind !== SyntaxKind.EndOfFileToken) {
+        if (isToken(node) && !isInsideComment(node) && node.kind !== SyntaxKind.EndOfFileToken) {
             const converted = convertToken(node, ast);
 
             if (converted) {

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

@@ -9,4 +9,13 @@ foo;
 /**
  * a
  */
-foo;
+foo;
+
+/**
+ * This is a function.
+ * @param {String} bar
+ * @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"),
             {