Turborepo
指南

单包工作区

虽然 Turborepo 在多包工作区（通常称为 monorepos）中非常有效，但它也可以用于加快单包工作区的速度。

Turborepo 最重要的功能在单包工作区中也能工作，包括本地和远程缓存以及任务并行化。不工作的功能是在单包上下文中没有意义的功能，例如包任务 (app#build)。

须知

单包工作区的示例是 npx create-next-app 或 npm create vite 的输出。

安装

将 turbo 安装到您的应用程序中

终端
npm install turbo --save-dev

使用全局 turbo 运行 package.json 脚本（可选）

为了获得更快的开发人员工作流程，您也可以全局安装 turbo，并直接从命令行运行命令。

安装完成后，您可以运行 turbo build，Turborepo 将从 package.json 中运行您的 build 脚本。再次运行 turbo build 将命中缓存。

此时，turbo 没有提供太多价值，因为您很可能只会在代码更改时才重新构建应用程序，并且当您的代码更改时，turbo 将错过缓存。只需两个简单的步骤，您就可以从 turbo 中获得更多收益。

使用一个命令运行多个脚本

在许多存储库中，都有一些设置任务或预构建步骤要运行。这些任务通常一次运行一个 - 但您可以使用 turbo 轻松地将它们转换为一个脚本。

例如，假设您有一个项目，在每次开始工作时都必须设置开发环境。您需要

  1. 启动数据库的 Docker 容器。
  2. 将数据库模式推送到数据库。
  3. 使用数据填充数据库。
  4. 启动开发服务器。

您可以使用 Turborepo 将这些任务安排到一个命令中。首先，在您的 package.json 中创建脚本

package.json
{
  "name": "@acme/my-app",
  "version": "0.0.0",
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint",
    "check-types": "tsc --noEmit",
    "db:up": "docker-compose up -d",
    "db:push": "your-orm-tool schema-push",
    "db:seed": "node ./db-seed.js"
  }
}

然后，在 turbo.json 中创建任务以按顺序运行这些脚本

./turbo.json
{
  "tasks": {
    "dev": {
      "dependsOn": ["db:seed"],
      "cache": false,
      "persistent": true
    },
    "db:seed": {
      "dependsOn": ["db:push"],
      "cache": false
    },
    "db:push": {
      "dependsOn": ["db:up"],
      "cache": false
    },
    "db:up": {
      "cache": false
    }
  }
}

上面任务中的 dependsOn 数组为任务创建了顺序。当您运行 turbo dev 时（作为 package.json 脚本或在您的终端中），

并行化任务

使用 turbo 并行化任务可以通过同时运行所有任务来加快任务速度（如果可以）。例如，您可以同时运行 ESLint、TypeScript 和 Prettier 检查。给定如下脚本

./package.json
{
  "scripts": {
    "lint": "eslint .",
    "format": "prettier .",
    "check-types": "tsc --noEmit"
  }
}

您可以创建一个这样的配置

turbo.json
{
  "tasks": {
    "lint": {},
    "format": {},
    "check-types": {}
  }
}

然后，要同时运行所有任务

终端
turbo check-types lint format

使用输入优化任务

由于 Turborepo 会将单包工作区视为一个包，因此它可以帮助优化任务的输入，以确保不相关的更改不会导致缓存未命中。

例如，可以使用仅包含 TypeScript 文件的输入来配置用于使用 tsc --noEmit 检查类型的脚本

./turbo.json
{
  "tasks": {
    "check-types": {
      "inputs": ["**/*.{ts,tsx}"]
    }
  }
}

上一步

Vitest

下一步

生成代码

小时

总计算量节省
开始使用
远程缓存 →

在此页面

安装使用全局 turbo 运行 package.json 脚本（可选）使用一个命令运行多个脚本并行化任务使用输入优化任务