进阶 oclif.io 2026-10-18 02:37:03 · 28 阅读
第5章 oclif TSLint 迁移至 ESLint 指南
oclif TSLint to ESLint Migration
December 5, 2019 · 3 min read 今年二月,社区宣布将废弃 TSLint,转而推荐 ESLint。TSLint 的目标已转变为支持 ESLint 开发,以实现"统一的开发者体验"。 oclif 的变化 为了紧跟社区步伐,oclif 的所有核心库和官方插件均已迁移至 ESLint。 从 v1.15.x 版本起,oclif 生成的 TypeScript 和 JavaScript CLI 项目可选地使用 ESLint。 ESLint 要求 Node 处于稳定 LTS 版本,在撰写本文时,支持的版本为 Node 8.10.x、Node 10.13.x 和 Node 12.x.x。 这对你有什么影响 现有的 CLI 保持不变,但新生成的 CLI 仅提供使用 ESLint 的选项。如果你的 CLI 正在运行 tslint,建议你也切换到 ESLint。 在迁移项目过程中,我们采取了以下步骤(变更示例见此 pull request)。 安装 eslint $ yarn add eslint eslint-config-oclif eslint-config-oclif-typescript --dev 添加 eslint 相关文件 $ echo '{"extends": [
"oclif",
"oclif-typescript"
],
"rules": {
}
}' > .eslintrc
移除 tslint 及相关包 $ yarn remove @oclif/tslint tslint 移除 tslint 相关配置文件 $ rm tslint.json 修改 package.json 中的 lint 脚本,从类似: "lint": "tsc -p test --noEmit && tslint -p test -t stylish" 改为: "lint": "eslint . --ext .ts --config .eslintrc" 为了保留测试编译步骤(tsc -p test --noEmit),我们还对 scripts 进行了如下更新: "pretest": "tsc -p test --noEmit" 在某些情况下,posttest 脚本会与 lint 脚本重复相同的步骤,因此更清晰的做法是直接引用 lint 任务: "posttest": "yarn lint" 运行 yarn lint --fix。这将尝试自动修复所有 lint 违规问题。如果没有可用的自动修复方案,则需要手动修复或忽略(更多详情请参阅 eslint 配置文档)。 在代码库中搜索 tslint,并删除不必要的 tslint 禁用注释,例如: /* tslint:disable:object-literal-sort-keys */
如果你使用的 Node 版本不受 ESLint 支持,还需要升级 Node。ESLint 支持 Node 8、10 和 12,因此建议升级到与你的 CLI 兼容、且被 ESLint 支持的最新版本(详见 ESLint 的安装与使用说明)。
何时生效
这些变更已在 oclif v1.15.1 中生效。新生成的 CLI 或插件将包含 ESLint 的配置,而不再是 TSLint。