如何通过TypeScript AST从方法返回类型中获取命名空间与包信息？

完全可以通过TypeScript编译器API结合AST实现这个需求，核心是利用类型检查器（TypeChecker）解析返回类型的符号（Symbol）信息，进而推导其所属包和命名空间归属。

核心实现步骤 #

1. 定位方法节点并获取返回类型节点
   遍历AST找到目标MethodDeclaration或FunctionDeclaration节点，访问其type属性得到返回类型的AST节点（通常是TypeReferenceNode）。

2. 通过类型检查器解析符号信息
   使用checker.getTypeFromTypeNode()将返回类型节点转换为Type对象，再调用type.getSymbol()获取该类型对应的符号。符号包含了类型的定义位置、上下文等关键元数据。

3. 判断是否来自外部包
   从符号的getDeclarations()方法中获取类型的定义节点，检查定义节点所在的源文件：

   • 如果是声明文件（isDeclarationFile()返回true）且文件路径包含node_modules，则该类型来自外部包。
   • 可以通过文件路径提取包名（比如从node_modules/pkg-name/...中截取pkg-name）。

4. 判断是否通过命名空间暴露
   遍历符号的父符号链：

   • 检查父符号的flags是否包含SymbolFlags.Namespace，如果找到符合条件的父符号，则说明该类型是通过命名空间暴露的。

代码示例 #

import * as ts from "typescript";

// 初始化TS程序和类型检查器
const program = ts.createProgram(["target-file.ts"], {});
const checker = program.getTypeChecker();

// AST遍历函数
function visitNode(node: ts.Node) {
  // 定位方法或函数声明
  if (ts.isMethodDeclaration(node) || ts.isFunctionDeclaration(node)) {
    const returnTypeNode = node.type;
    // 仅处理类型引用节点（如`SomeType`或`Ns.SomeType`）
    if (returnTypeNode && ts.isTypeReferenceNode(returnTypeNode)) {
      const type = checker.getTypeFromTypeNode(returnTypeNode);
      const symbol = type.getSymbol();

      if (symbol) {
        const declarations = symbol.getDeclarations();
        if (declarations?.length) {
          const decl = declarations[0];
          const sourceFile = decl.getSourceFile();

          // 判断是否来自外部包
          const isExternalPackage = sourceFile.isDeclarationFile() && sourceFile.fileName.includes("node_modules");
          console.log(`返回类型是否来自外部包: ${isExternalPackage}`);

          // 提取外部包名
          if (isExternalPackage) {
            const packageName = sourceFile.fileName.split("node_modules/")[1]?.split("/")[0];
            console.log(`所属包名: ${packageName ?? "无法识别包名"}`);
          }

          // 判断是否通过命名空间暴露
          let currentSymbol = symbol;
          let isInNamespace = false;
          while (currentSymbol.parent) {
            currentSymbol = currentSymbol.parent;
            if (currentSymbol.flags & ts.SymbolFlags.Namespace) {
              isInNamespace = true;
              break;
            }
          }
          console.log(`返回类型是否通过命名空间暴露: ${isInNamespace}`);
        }
      }
    }
  }
  // 递归遍历子节点
  ts.forEachChild(node, visitNode);
}

// 启动遍历
const targetSourceFile = program.getSourceFile("target-file.ts");
if (targetSourceFile) {
  visitNode(targetSourceFile);
}

注意事项 #

• 对于类型别名（type Alias = SomeType），需要调用checker.getAliasedSymbol(symbol)追根溯源到原始类型的符号。
• 内置类型（如string、number）的定义来自TS自带的声明文件，不属于第三方包。
• 部分复杂类型（如联合类型、交叉类型）需要先拆解为基础类型再分析。

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