快速开始

编辑器集成

了解如何将 Turborepo 与您的编辑器集成以获得最佳开发体验。

为了获得 turbo 的最佳体验,Turborepo 提供了一些与编辑器集成的实用工具。

turbo.json 的 JSON Schema

Turborepo 使用 JSON Schema 在您的 turbo.json 文件中提供自动补全功能。通过在 turbo.json 中包含 $schema 键,您的编辑器能够提供完整的文档和语法检查,以防您有无效的结构或缺少键值。

从网络获取

可以通过下面显示的 URL 访问 schema.json。这样做的优点是不需要运行包管理器的安装命令就能在编辑器中看到验证。

{
  "$schema": "https://turborepo.com/schema.json"
}

还有一个主要版本化的 schema.json 可用,格式为 https://turborepo.com/schema.<version>.json

{
  "$schema": "https://turborepo.com/schema.v1.json"
}

node_modules 获取

从 Turborepo 2.4 开始,一旦您运行了包管理器的安装命令,schema.json 就可以在 node_modules 中使用:

{
  "$schema": "./node_modules/turbo/schema.json"
}

我们建议在仓库的根目录安装 turbo,因此 schema 的路径应该指向仓库根目录的 node_modules。在包配置中,您可能需要使用类似 ../../node_modules/turbo/schema.json 的路径。

环境变量的语法检查

处理环境变量是在 Turborepo 中构建应用程序的重要部分。

eslint-config-turbo扩展了您的 ESLint 设置,帮助您确保已经处理了所有环境变量。

Turborepo LSP

启用比 JSON Schema 提供的更多自动补全和语法检查功能,包括编辑器内对无效 glob、对不存在任务或包的引用的提示,以及额外的仓库可见性工具。

访问 VSCode 扩展市场 进行安装。

语言服务器可以在任何支持语言服务器协议的编辑器上使用。请在我们的问题跟踪器中记录请求以表达您的兴趣。