ts-morph项目中使用默认导出函数声明的正确方式

在JavaScript/TypeScript开发中，我们经常需要导出函数供其他模块使用。ts-morph作为一个强大的TypeScript AST操作库，提供了多种方式来操作和生成代码。本文将详细介绍在ts-morph中如何正确实现函数声明的默认导出。

默认导出函数声明的两种语法形式

在TypeScript/JavaScript中，函数声明的默认导出有两种等效的语法形式：

1. 使用export default关键字直接导出函数声明：

export default function functionName() {}

2. 先声明函数再通过导出赋值导出：

function functionName() {}
export default functionName

虽然这两种形式在功能上是等价的，但在AST(抽象语法树)层面，它们被表示为完全不同的结构。

ts-morph中的实现方式

在ts-morph中，我们需要根据不同的AST结构选择不同的API来实现函数导出：

1. 直接导出函数声明

推荐使用addFunction方法并设置isDefaultExport参数为true：

sourceFile.addFunction({
  name: "functionName",
  isDefaultExport: true,
  statements: "// 函数实现"
});

这种方式会生成第一种语法形式，直接在导出时声明函数。

2. 先声明后导出

如果需要先声明函数再导出，可以使用以下方式：

const func = sourceFile.addFunction({
  name: "functionName",
  statements: "// 函数实现"
});

sourceFile.addExportAssignment({
  expression: func.getName(),
  isExportEquals: false
});

这种方式会生成第二种语法形式，先声明函数再通过导出赋值导出。

常见错误及解决方案

开发者在使用ts-morph时可能会尝试以下方式：

// 错误方式：会导致NotImplementedError
sourceFile.insertExportAssignment(position, {
  expression: 'function functionName() {}',
  isExportEquals: false,
});

这是因为insertExportAssignment方法设计用于处理已经存在的标识符的导出，而不是直接在导出时声明新函数。

正确的替代方案包括：

1. 使用addFunction配合isDefaultExport参数
2. 使用insertStatements直接插入完整的导出语句：

sourceFile.insertStatements(position, 'export default function functionName() {}');

最佳实践建议

1. 优先使用addFunction配合isDefaultExport参数，这种方式最符合ts-morph的设计理念
2. 当需要精确控制代码位置时，可以使用insertStatements
3. 避免直接操作AST节点除非有特殊需求
4. 保持代码生成方式的一致性，选择一种风格并在项目中统一使用

理解这些差异和正确用法将帮助开发者更高效地使用ts-morph进行代码生成和转换操作。