如何在TypeScript中将接口转换为字符串并保存到文件？

1. 使用TypeScript Compiler API（官方原生方案） #

TypeScript自带的Compiler API可以直接解析源码、遍历AST语法树节点，精准提取接口的文本内容。

实现步骤： #

• 先安装依赖：npm install typescript --save-dev
• 编写提取脚本示例：

import * as ts from 'typescript';
import * as fs from 'fs';

// 配置文件路径
const sourceFilePath = './src/cat.ts';
const outputFilePath = './somefile.ts';

// 创建TS程序实例，解析目标文件
const program = ts.createProgram([sourceFilePath], {});
const sourceFile = program.getSourceFile(sourceFilePath);

if (!sourceFile) throw new Error(`找不到目标文件: ${sourceFilePath}`);

let interfaceText = '';
// 遍历AST节点，匹配目标接口
ts.forEachChild(sourceFile, (node) => {
  if (ts.isInterfaceDeclaration(node) && node.name.text === 'cat') {
    // 配置打印选项，保证输出格式和原代码一致
    const printer = ts.createPrinter({
      newLine: ts.NewLineKind.LineFeed,
      indentWidth: 4,
    });
    interfaceText = printer.printNode(ts.EmitHint.Unspecified, node, sourceFile);
  }
});

// 将接口文本写入目标文件
if (interfaceText) {
  fs.writeFileSync(outputFilePath, interfaceText);
  console.log(`接口已写入 ${outputFilePath}`);
} else {
  console.log('未找到cat接口');
}

2. 使用ts-morph（封装后的简化方案） #

ts-morph是对Compiler API的上层封装，提供了更友好的API，代码更简洁易读。

实现步骤： #

• 安装依赖：npm install ts-morph --save-dev
• 编写提取脚本示例：

import { Project } from 'ts-morph';
import * as fs from 'fs';

const project = new Project();
// 加载要解析的源文件
const sourceFile = project.addSourceFileAtPath('./src/cat.ts');
// 获取目标接口
const catInterface = sourceFile.getInterface('cat');

if (catInterface) {
  // 直接获取接口的完整文本
  const interfaceText = catInterface.getText();
  // 写入文件
  fs.writeFileSync('./somefile.ts', interfaceText);
  console.log('接口已生成并保存');
} else {
  console.log('未找到cat接口');
}

关键注意事项 #

• 你示例中的convertInterfaceToString(cat)写法不可行：TypeScript接口是编译时类型，编译后会被完全擦除，运行时不存在对应的变量。必须通过静态分析源码的方式提取接口内容。
• 可以通过打印选项（如缩进宽度、换行符类型）调整输出格式，确保和原接口的排版完全匹配。

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