如何开发可保留代码格式、支持AST转换的多语言重构工具？

通用多语言方案（同时满足多语言支持、格式保留、AST转换需求） #

• 带格式信息的通用解析框架
  这类框架生成的语法树会默认存储原始代码的空格、换行、注释等非语法核心的边缘信息（一般称为trivia节点），无需手动处理格式映射逻辑：
  • Tree-sitter：支持超过100种编程语言的解析，生成的语法树绑定了全部原始字符的位置信息，修改AST节点后支持增量输出，完全保留未修改部分的原有格式，自带模式匹配查询能力，可直接匹配弃用函数的调用模式完成替换，不需要从零编写语法规则。
  • 若你想沿用ANTLR技术栈，可搭配ANTLR官方的TokenStreamRewriter工具类，不需要完全依赖AST做输出，直接基于原始token流做增删改操作，只要定位到弃用函数对应的token范围完成替换，未改动的token会完全保留原有格式、注释、换行。
• 通用代码转换框架
  OpenRewrite：原生支持Java、Python、JavaScript、Kotlin等十几种常用语言，内置AST节点的格式保留逻辑，你只需要定义转换规则（比如弃用函数的匹配逻辑和替换规则），框架会自动处理格式保留相关的细节，不需要额外处理排版逻辑，还自带批量迁移、增量修改能力。

特定语言原生方案（针对单一语言开发时的最优选择） #

• JavaScript/TypeScript：可使用jscodeshift或ts-morph，两者都基于TypeScript AST，原生保留全部原始格式，修改后输出不会改动未涉及代码的排版，社区有大量现成的废弃API迁移脚本可供参考。
• Java：可使用IntelliJ IDEA的PSI体系或上述的OpenRewrite，PSI树自带完整的格式信息，修改后可直接生成保留原有格式的代码，IDEA还自带结构搜索替换功能，可快速验证转换规则的正确性。
• Python：可使用libCST，解析生成的具体语法树完全保留所有原始格式信息，支持AST风格的节点修改，替换完成后直接输出即可保留原有排版，比Python标准库的ast模块更适合重构工具开发。
• Go：可使用标准库的go/ast搭配go/printer，只要修改时保留节点的位置信息，printer可输出保留大部分原有格式的代码，也可使用golang.org/x/tools/go/analysis框架实现标准化的迁移规则。

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