Refactor to avoid crawling up tree on every converted token

Author: Kai Cataldo

lib/node-utils.js

@@ -185,7 +185,11 @@ module.exports = {
     convertTokens,
     getNodeContainer,
     isWithinTypeAnnotation,
-    isTypeKeyword
+    isTypeKeyword,
+    isComment,
+    isJSDocNode,
+    isJSDocCommentContainingNode,
+    isJSDocTag
 };
 /* eslint-enable no-use-before-define */
 
@@ -245,30 +249,40 @@ function isComma(token) {
 }
 
 /**
- * Returns true if the given TSToken is a comment
- * @param  {TSToken}  token the TypeScript token
- * @returns {boolean}       is commment
+ * Returns true if the given TSNode is a comment
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} is commment
  */
-function isComment(token) {
-    return (token.kind === SyntaxKind.SingleLineCommentTrivia || token.kind === SyntaxKind.MultiLineCommentTrivia) || (token.kind >= SyntaxKind.JSDocTypeExpression && token.kind <= SyntaxKind.JSDocTypeLiteral);
+function isComment(node) {
+    return node.kind === SyntaxKind.SingleLineCommentTrivia || node.kind === SyntaxKind.MultiLineCommentTrivia;
 }
 
 /**
- * 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
+ * Returns true if the given TSNode is a JSDoc node
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} is JSDoc node
  */
-function isInsideComment(token) {
-    if (token.kind === SyntaxKind.SourceFile) {
-        return false;
-    }
-    if (isComment(token)) {
-        return true;
-    }
-    return isInsideComment(token.parent);
+function isJSDocNode(node) {
+    return node.kind >= SyntaxKind.FirstJSDocNode && node.kind <= SyntaxKind.LastJSDocNode;
+}
+
+/**
+ * Returns true if the given TSNode is a JSDoc tag
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} isJSDoc tag
+ */
+function isJSDocTag(node) {
+    return node.kind >= SyntaxKind.FirstJSDocTagNode && node.kind <= SyntaxKind.LastJSDocTagNode;
 }
 
+/**
+ * Returns true if the given TSNode contains a JSDoc comment
+ * @param {TSNode} node the TypeScript node
+ * @returns {boolean} contains JSDoc comment
+ */
+function isJSDocCommentContainingNode(node) {
+    return node.kind === SyntaxKind.JSDocComment || isJSDocTag(node);
+}
 
 /**
  * Returns the binary expression type of the given TSToken
@@ -282,7 +296,6 @@ function getBinaryExpressionType(operator) {
         return "LogicalExpression";
     }
     return "BinaryExpression";
-
 }
 
 /**
@@ -719,7 +732,13 @@ function convertTokens(ast) {
      * @returns {undefined}
      */
     function walk(node) {
-        if (isToken(node) && !isInsideComment(node) && node.kind !== SyntaxKind.EndOfFileToken) {
+        // 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) || isJSDocCommentContainingNode(node)) {
+            return;
+        }
+
+        if (isToken(node) && node.kind !== SyntaxKind.EndOfFileToken) {
             const converted = convertToken(node, ast);
 
             if (converted) {

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

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