如何用TypeScript Compiler API查找函数体内的return语句

这是StackOverflow问题《Find node of specific SyntaxKind in ASL tree with typescript compiler api》的后续内容，面向后续谷歌搜索用户，聚焦return语句的查找需求。

需求是通过TypeScript Compiler API查找方法体内的所有return语句，但函数体结构不确定（比如可能存在嵌套的try/catch、if块等），不想通过静态遍历不同节点类型的方式实现。曾尝试使用visitFunctionBody，但该函数需要上下文，且TypeScript已不再导出相关转换器工厂成员，不确定是否能满足需求。

之前尝试的代码如下，但无法处理嵌套结构的情况：

function findReturnStatements(node: Node) {
    const children: Node[] = [];
    node.forEachChild((childNode) => {
      children.push(childNode);
    });
    return children.filter(isReturnStatement);
}

比如以下两种函数体结构，前者能找到return语句，但后者无法捕获嵌套在try/catch内的return：

someMethod() {
  return 3;
}

// vs 

someMethod() {
  try {
    return 3;
  } catch (e) {
    return 4;
  }
}

解决方案：深度遍历AST捕获所有return语句 #

要处理任意嵌套结构的return语句，核心是对AST进行深度遍历，可以通过手动递归或TypeScript官方提供的visit工具函数实现：

方法1：手动递归遍历节点 #

通过递归遍历每个节点的子节点，逐一检查是否为ReturnStatement：

import * as ts from "typescript";

function findAllReturnStatements(node: ts.Node): ts.ReturnStatement[] {
    const returns: ts.ReturnStatement[] = [];
    
    // 检查当前节点是否为return语句
    if (ts.isReturnStatement(node)) {
        returns.push(node);
    }
    
    // 递归遍历所有子节点
    node.forEachChild(child => {
        returns.push(...findAllReturnStatements(child));
    });
    
    return returns;
}

方法2：使用TypeScript官方visit函数 #

TypeScript提供的ts.visit是更健壮的AST遍历工具，结合自定义Visitor实现深度查找：

import * as ts from "typescript";

function findAllReturnStatements(node: ts.Node): ts.ReturnStatement[] {
    const returns: ts.ReturnStatement[] = [];
    
    ts.visit(node, {
        visitNode(node) {
            if (ts.isReturnStatement(node)) {
                returns.push(node);
            }
            // 继续遍历子节点
            return ts.visitEachChild(node, this.visitNode, undefined);
        }
    });
    
    return returns;
}

使用示例 #

假设已获取到目标方法的函数体节点（FunctionBody类型），直接调用上述函数即可：

// 假设functionBody是目标方法的函数体节点
const returnStatements = findAllReturnStatements(functionBody);
console.log(returnStatements.length); // 嵌套try/catch的例子会输出2

说明 #

• 两种方法都能穿透所有嵌套层级（try/catch、if、for等块级结构），捕获所有return语句。
• ts.visit是官方推荐的AST遍历方式，相比手动递归能更稳妥地处理所有节点类型的遍历逻辑。

内容的提问来源于stack exchange，提问作者Ced