TypeScript 如何解析、修改和重新生成 TypeScript 文件的 AST（类似于 jscodeshift）

在本文中，我们将介绍如何使用 TypeScript 解析、修改和重新生成 TypeScript 文件的 AST（抽象语法树），类似于 jscodeshift。通过对 TypeScript AST 的操作，我们可以轻松地进行代码分析、重构和自动化重写等操作，从而提高开发效率和代码质量。

阅读更多：TypeScript 教程

什么是 AST？

抽象语法树（AST）是源代码的结构化表示形式，它通过树状结构来表示代码的语法结构和语义。在 TypeScript 中，AST 是对 TypeScript 代码进行分析、转换和生成的重要工具。

解析 TypeScript 文件的 AST

首先，我们需要使用 TypeScript 的编译器 API 来解析 TypeScript 文件并生成 AST。可以通过以下代码示例来实现：

import * as ts from "typescript";

const filePath = "path/to/your/file.ts";
const sourceCode = ts.readFileSync(filePath, "utf-8");

function parseTypeScriptFile(filePath: string, sourceCode: string): ts.Node {
  const result = ts.transpileModule(sourceCode, {
    fileName: filePath,
    compilerOptions: { target: ts.ScriptTarget.Latest, module: ts.ModuleKind.CommonJS }
  });

  const ast = ts.createSourceFile(filePath, result.outputText, ts.ScriptTarget.Latest, true);
  return ast;
}

const ast = parseTypeScriptFile(filePath, sourceCode);

以上代码中，我们首先使用 ts.readFileSync 方法读取 TypeScript 文件的源代码，然后使用 ts.transpileModule 方法对源代码进行转换，得到转译后的代码和一个 AST。我们可以通过调用 ts.createSourceFile 方法来创建 AST。

修改 TypeScript 文件的 AST

一旦我们获取了 TypeScript 文件的 AST，我们就可以对其进行修改。TypeScript 提供了丰富的 API 来操作 AST，例如 ts.visitNode、ts.create 等方法。通过这些方法，我们可以遍历 AST 并进行增删改操作。

下面是一个简单的示例，演示了如何将 TypeScript 文件的所有函数名替换为大写：

function transformAST(ast: ts.Node) {
  return ts.visitNode(ast, function walker(node) {
    if (ts.isFunctionDeclaration(node) || ts.isMethodDeclaration(node)) {
      const functionName = (node.name as ts.Identifier).text;
      const upperCaseFunctionName = functionName.toUpperCase();
      const upperCaseIdentifier = ts.createIdentifier(upperCaseFunctionName);
      return ts.updateFunctionDeclaration(node, node.decorators, node.modifiers, upperCaseIdentifier, node.typeParameters, node.parameters, node.type, node.body);
    }
    return ts.visitEachChild(node, walker, null);
  });
}

const transformedAST = transformAST(ast);

以上代码中，我们使用 ts.visitNode 方法遍历 AST，当遇到函数声明或方法声明时，我们将函数名转换为大写并通过 ts.updateFunctionDeclaration 方法更新节点。

重新生成 TypeScript 文件的 AST

在对 TypeScript 文件的 AST 进行修改后，我们可以将更新后的 AST 转换回源代码。可以使用以下代码实现：

function generateCode(ast: ts.Node): string {
  const printer = ts.createPrinter();
  return printer.printFile(ast);
}

const updatedCode = generateCode(transformedAST);

以上代码中，我们使用 ts.createPrinter 方法创建一个 AST 打印机，然后通过 printer.printFile 方法将 AST 转换回源代码。

示例

下面是一个完整的示例，演示了如何解析、修改和重新生成 TypeScript 文件的 AST，并将所有的字母 A 替换为字母 B：

import * as ts from "typescript";

const filePath = "path/to/your/file.ts";
const sourceCode = ts.readFileSync(filePath, "utf-8");

function parseTypeScriptFile(filePath: string, sourceCode: string): ts.Node {
  const result = ts.transpileModule(sourceCode, {
    fileName: filePath,
    compilerOptions: { target: ts.ScriptTarget.Latest, module: ts.ModuleKind.CommonJS }
  });

  const ast = ts.createSourceFile(filePath, result.outputText, ts.ScriptTarget.Latest, true);
  return ast;
}

function transformAST(ast: ts.Node) {
  return ts.visitNode(ast, function walker(node) {
    if (ts.isIdentifier(node)) {
      const text = node.text;
      const transformedText = text.replace(/A/g, "B");
      return ts.createIdentifier(transformedText);
    }
    return ts.visitEachChild(node, walker, null);
  });
}

function generateCode(ast: ts.Node): string {
  const printer = ts.createPrinter();
  return printer.printFile(ast);
}

const ast = parseTypeScriptFile(filePath, sourceCode);
const transformedAST = transformAST(ast);
const updatedCode = generateCode(transformedAST);

console.log(updatedCode);