跳到主要内容

TypeScript 的一流支持

·6 分钟阅读
Luna Wei
魏璐娜
Meta 软件工程师
Nick Gerleman
尼克·格尔曼(Nick Gerleman)
Meta 软件工程师

随着 0.71 版本的发布,React Native 通过以下更改投入 TypeScript 体验:

在这篇文章中,我们将介绍这些变化对您作为 TypeScript 或 Flow 用户意味着什么。

新应用程序模板默认采用 TypeScript

从 0.71 开始,当您通过 React Native CLI 创建新的 React Native 应用程序时,您将默认获得一个 TypeScript 应用程序!

npx react-native init My71App --version 0.71.0

Screenshot of an iPhone simulator running a new app generated by React Native CLI. Alongside the simulator is a screenshot of Visual Studio Code editor opened to "App.tsx" to illustrate it is running a TypeScript file.

新生成的应用程序的起点将是 App.tsx 而不是 App.js ——完全 TypeScript 类型化。新项目已经设置了 tsconfig.json,因此您的 IDE 将立即帮助您编写类型化代码!

随 React Native 一起发布的声明

0.71 是第一个内置 TypeScript (TS) 声明的版本。

此前,React Native 的 TypeScript 声明由 @types/react-native 提供,托管在 DefinitelyTyped 存储库中。将 TypeScript 类型与 React Native 源代码放在一起是为了提高正确性和维护性。

@types/react-native 仅提供稳定版本的类型。这意味着如果您想使用预发布版本的 React Native 进行 TypeScript 开发,您将不得不使用旧版本中的类型,这可能不准确。发布 @types/react-native 也容易出错。发布滞后于 React Native 发布,并且该过程涉及手动检查 React Native 公共 API 中发生的类型更改并更新 TS 声明以匹配。

通过将 TS 类型与 React Native 源代码放在一起,TS 类型具有更高的可见性和所有权。我们的团队正在积极开发工具以保持 Flow 和 TS 之间的一致性。

此更改还消除了 React Native 用户需要管理的依赖项。升级到 0.71 或更高版本时,您可以删除 @types/react-native 作为依赖项。请参阅新应用程序模板,了解如何设置 TypeScript 支持。

我们计划从 0.73 及更高版本开始弃用 @types/react-native。具体来说,这意味着

  • 将发布跟踪 React Native 0.71 和 0.72 版本的 @types/react-native。它们将与相关发布分支上的 React Native 中的类型相同。
  • 对于 React Native 0.73 及更高版本,TS 类型将仅从 React Native 中可用。

如何迁移

请尽快迁移到新的共置类型。以下是根据您的需求进行迁移的更多详细信息。

应用程序维护者

升级到 React Native >= 0.71 后,您可以从 devDependency 中删除 @types/react-native

注意

如果您因为使用的库引用了 @types/react-native 作为 peerDependency 而收到警告,请为该库提交问题或打开 PR,以使用 可选的 peerDependencies,并暂时忽略该警告。

库维护者

针对低于 0.71 版本的 React Native 的库可以使用 @types/react-nativepeerDependency 来对照应用程序版本的类型进行类型检查。此依赖项应在 peerDependenciesMeta 中标记为可选,以便不需要类型用于没有 TypeScript 的用户或 0.71 用户,其中类型是内置的。

依赖于 @types/react-native 的 TypeScript 声明的维护者

查看 0.71 版本引入的重大更改,看看您是否已准备好迁移。

如果我使用 Flow 怎么办?

Flow 用户可以继续对以 0.71+ 为目标的应用程序进行类型检查,但其配置逻辑不再包含在模板中。

Flow 用户之前通过合并新应用程序模板中的 .flowconfig 并手动更新 flow-bin 来升级 React Native 的 Flow 类型。新应用程序模板不再有 .flowconfig,但 React Native 存储库中仍然存在一个,可以用作您应用程序的基础。

如果您需要在 Flow 中启动一个新的 React Native 应用程序,您可以参考 0.70 中的新应用程序模板

如果我在 TypeScript 声明中发现错误怎么办?

无论您使用的是内置 TS 类型还是 @types/react-native,如果您发现错误,请同时向 React NativeDefinitelyTyped 存储库提交 PR。如果您不知道如何修复它,请在 React Native 存储库中提交 GitHub 问题,并在问题中提及 @lunaleaps

文档以 TypeScript 为主

为确保一致的 TypeScript 体验,我们对 React Native 文档进行了多项更新,以反映 TypeScript 作为新的默认语言。

代码示例现在允许内联 TypeScript,并且已更新了 170 多个交互式代码示例,以在新模板中通过 linting、格式化和类型检查。大多数示例在 TypeScript 和 JavaScript 中都有效。如果它们不兼容,您可以以任何一种语言查看示例。

如果您发现错误或有改进,请记住网站也是开源的,我们很乐意看到您的 PR!

感谢 React Native TypeScript 社区!

最后,我们希望感谢社区多年来为确保 TypeScript 可供 React Native 开发人员使用所做的所有工作。

我们要感谢自 2015 年以来一直维护 @types/react-native 的所有贡献者!我们看到了你们为确保 React Native 用户拥有最佳体验所付出的努力和关怀。

感谢 @acoates@eps1lon@kelset@tido64@Titozzz@ZihanChen-MSFT 帮助咨询、提问、沟通和审查将 TypeScript 类型迁移到 React Native 的更改。

同样,我们还要感谢 react-native-template-typescript 的维护者,他们从第一天起就为 React Native 中的新应用程序开发提供了 TypeScript 体验支持。

我们期待在 React Native 存储库中更直接地协作,并继续改进 React Native 开发人员体验!