返回资讯中心
外部精选
软件工程
#开发者实时流

Yelp将大型Flow单体仓库迁移至TypeScript

来源标题:Migrating a Large Flow Monorepo to TypeScript

Yelp 旗下 Webcore 团队已将大型 Flow 单体仓库迁移到 TypeScript。该团队 2017 年选用 Flow,但 2021 年 Flow 团队宣布转向优先满足 Facebook 内部需求后,于 2022 年初启动迁移。迁移过程中坚持不临时关闭类型检查、不批量插入忽略注释,以维持对类型检查的信任。

Hacker News 最新fagnerbrack2026/11/15 · 2 天前30 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

2017 年初,Webcore 选择 Flow 而非 TypeScript,作为 Yelp 的下一代类型检查器。当时并没有明显的领先者。Flow 对 React 的支持更好,性能更佳,并且在 flow-typed 中拥有相当可观的 NPM 包类型库。然而几年之后,格局发生了变化,TypeScript 显然正在成为更强的选择。TypeScript 的 DefinitelyTyped 仓库比 flow-typed 多出数千个包,而且更多包自带 TypeScript 类型声明。TypeScript 也随着时间推移被证明更加稳定,而 Flow 在更广泛的 JS 社区中采用有限,导致寻找 Flow 的工具和文档相对困难。2021 年中,Flow 团队宣布将重心重新转向 Facebook 的内部需求,而非 OSS 社区的需求,这清楚地表明 TypeScript 是更合适的选择。我们在 2022 年初开始规划迁移。

我们的北极星是维持并增强对类型检查的信任。这意味着要避免“临时”禁用类型检查、批量插入“typecheck ignore”注释,并且要在整个过程中保持类型完整性。信任一旦破裂就很难重建,而且我们发现,代码一旦失去类型检查器、测试或 linter 的覆盖,几乎就再也无法恢复。

这立刻排除了大多数方案。一次性大规模重写本应是理想选择,但即便是世界上最好的 codemod,也不足以在假期期间把一百万行以上的代码转换完成且几乎不出错。在我们的主 Web 仓库中进行代码冻结、再手动迁移,也同样不可行。

但既然无法一次性完成迁移,那就意味着我们必须逐步进行。而如果必须逐步进行,那就意味着我们不得不同时在同一个仓库中、在生产环境中同时处理 Flow 和 TypeScript 代码,且不能丢失类型安全。这让我们感到紧张,但经过大量研究和原型验证,我们决定可以做到。

我们的计划是将整个 monorepo 逐个包地转换为 TypeScript。我们使用一个名为 flowts 的开源包来完成大部分 Flow 到 TypeScript 的转换工作,并辅以我们自己编写的一些 codemod 来处理我们发现的常见边缘情况。遗憾的是,有许多错误无法通过 codemod 自动修复,几乎总是需要人工介入才能完成转换。其中大多数源于 Flow 和 TypeScript 在处理类型方式上的细微差异,而且通常因包或团队而异。对于那些频繁出现、但模式不够一致而无法用 codemod 处理的错误,我们记录了推荐的解决方案。完成转换仍然需要大量人工投入,但工具链仍然节省了数万小时令人麻木的工程师工时。

一个包成功转换为 TypeScript 后,我们会使用另一个出色的开源工具 flowgen,将 TS 类型检查器生成的 .d.ts 类型声明转换回 Flow 兼容的类型头文件。这同样需要一些调试才能可靠运行,但我们最终把工具链打磨到了这样的程度:将一个包转换为 TypeScript 变得快速、简单,并且能与所有导入它的 Flow 代码无缝地进行类型检查。遗憾的是,没有等效的工具能从 Flow 代码生成 .d.ts 头文件,因此我们必须从最深的 Yelp 内部依赖开始,然后沿着依赖树向上重复这一过程。这最终成为整个迁移过程中的一根刺,但替代方案是牺牲包之间的类型完整性,而我们已经下定决心要避免这一点。

这一迁移方案之所以可行,是因为我们当时刚把所有 JavaScript 代码迁移到了一个 Lerna monorepo 中。将所有 JavaScript 代码放在单个 monorepo 中,使我们能够通过一个 PR 更新工具以在整个生态系统中支持 TypeScript,而不是每个包各自一个仓库、需要数百个 PR。这也使我们能够一次转换一个包,并且只需在包级别处理 Flow/TS 互操作,而不必细到每个文件。每个包通常总共只有几千行代码,因此大多数迁移可以在一两天内完成;我们希望这样能让团队在值班职责的空档或其他工作间隙中转换一两个包。

最终的整体架构大致如下: 一张示意图,展示了我们在迁移期间如何使用 Babel、tsc、Webpack 和 Flowgen 让 Flow 和 TypeScript 类型协同工作。

让这两个转换工具达到可用状态,再加上完成所有 Webpack 和 Babel 的繁琐工作以使整个流程真正端到端跑通,花了好几个月。我们本可以在 2022 年中就直接上线,但我们知道第一印象只有一次机会。如果工具不可靠、缓慢或难以使用,我们的工程师会在一开始就对新类型检查器和工具链留下负面印象。即使我们后来修复了一切,这种情绪也会持续很长时间,使我们难以说服忙碌的功能团队从日程中抽出时间来做一个他们本来就不感兴趣的迁移。我们非常希望这次迁移能自己说服人。

我们开始了一段广泛的内部试用期。我们 Webcore 以及设计系统团队的同事一起,将大约 90 个基础包转换为了 TypeScript。这花了几个月时间,但我们发现了工具链中的几个问题,并在向全体 Yelp 工程师发布之前修复了它们。此外,我们的大部分样式指南包已经采用 TypeScript,这意味着一旦我们向功能团队发布,他们就可以立即开始转换自己的包,而无需等待依赖项被移植过来。

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →