Textlint项目中的API弃用与迁移指南

textlint作为一款强大的文本校验工具，在其13.0.0版本中进行了重大更新，引入了一系列新的API来替代旧有的接口。本文将详细介绍这些变更内容，帮助开发者顺利完成迁移。

弃用API概览

textlint团队在最新版本中标记了四个核心API为弃用状态：

1. textlint全局对象
2. TextLintCore类
3. TextLintEngine类
4. TextFixEngine类

这些API虽然仍能使用，但已不再推荐，开发者应尽快迁移到新的替代方案。

新老API对比

弃用API	推荐替代方案
textlint	使用@textlint/legacy-textlint-core或@textlint/kernel
TextLintCore	使用@textlint/legacy-textlint-core或@textlint/kernel
TextLintEngine	使用createLinter和loadTextlintrc组合
TextFixEngine	使用createLinter和loadTextlintrc组合

迁移实践指南

从TextLintEngine迁移

旧代码示例：

const { TextLintEngine } = require("textlint");
const engine = new TextLintEngine({
  formatterName: "stylish"
});
engine.executeOnFiles(["README.md"])
  .then(results => {
    console.log(engine.formatResults(results));
  });

新代码示例：

const { createLinter, loadTextlintrc, loadLinterFormatter } = require("textlint");
async function runLint() {
  const descriptor = await loadTextlintrc();
  const linter = createLinter({ descriptor });
  const results = await linter.lintFiles(["README.md"]);
  const formatter = await loadLinterFormatter({ formatterName: "stylish" });
  console.log(formatter.format(results));
}
runLint();

从TextLintCore迁移

对于直接使用TextLintCore的情况，最简单的迁移方式是替换导入路径：

- const { TextLintCore } = require("textlint");
+ const { TextLintCore } = require("@textlint/legacy-textlint-core");

弃用警告控制

Node.js提供了多种方式控制弃用警告的显示方式：

1. NODE_OPTIONS=--throw-deprecation - 将警告转为异常抛出
2. NODE_OPTIONS=--no-deprecation - 完全抑制警告
3. NODE_OPTIONS=--trace-deprecation - 显示完整堆栈跟踪

例如，要检查代码中是否使用了弃用API，可以运行：

NODE_OPTIONS=--throw-deprecation node your-script.js

架构设计演进

这次API变更反映了textlint架构的演进方向：

1. 职责分离：将核心功能与周边工具分离，@textlint/kernel专注于核心校验逻辑
2. 异步友好：新API全面支持Promise/async-await
3. 配置管理：引入descriptor概念，统一管理规则、插件和配置
4. 格式化分离：区分linter和fixer的格式化器

最佳实践建议

1. 新项目应直接使用新API
2. 现有项目应在下一个维护周期进行迁移
3. 对于复杂场景，可考虑分阶段迁移
4. 测试时启用--throw-deprecation确保无遗留用法

通过遵循这些指南，开发者可以顺利过渡到textlint的新API体系，享受更清晰、更强大的功能支持。