Skip to main content

turborepo

  • vercel/turborepo
    • 增量构建
    • 类似 nx，但支持多 package；类似 bazel
    • 适用于 monorepo 构建
    • 支持缓存、依赖
  • 缓存目录
    • node_modules/.cache/turbo/<HASH>
  • 项目配置 .turbo/config.json
    • teamid - team_XXX - TURBO_TEAM
    • apiurl - TURBO_API
    • TURBO_TOKEN
  • 全局 $XDG_CONFIG_HOME/turborepo/config.json
npx -y create-turbo@latest
cd my-turborepo/
npm run dev
npm run build

# 添加到已有项目
npm install turbo -D

# 运行定义的 pipeline
turbo run build
turbo run dev --parallel
turbo run lint

# vercel remote cache
npx turbo login
# team remote cache
npx turbo login --sso-team=<team-slug>
turbo.json
{
  "$schema": "https://turborepo.org/schema.json",
  "baseBranch": "origin/main"
}

starter

  • /apps/
    • web/
    • docs/
  • /packages/
    • ui/
    • config/ - eslint
    • tsconfig/

env

| env | | -------------------------------- | ------------------------------------- | | TURBO_API | | TURBO_TEAM | | TURBO_TOKEN | remote_cache 授权 | | TURBO_REMOTE_CACHE_SIGNATURE_KEY | | TURBO_HASH | | TURBO_REMOTE_ONLY | --remote-only - 只使用 remote cache | | TURBO_FORCE | --force | | FORCE_COLOR |

flags

flag | default | for ---|--- --env-mode | strict | 环境变量模式: strict, loose

  • --env-mode=strict
    • 只会传递定义的环境变量
      • env
      • passThroughEnv
      • globalEnv
      • globalPassThroughEnv

Caching​

Pipeline​

  • 缓存输出的文件和命令执行的输出
  • .turbo/run-<task>.log
  • node_modules/.cache/turbo - 很快就会变得 非常大
  • 环境变量 TURBO_HASH 依据
    • inputs, package.json 中依赖, 内部依赖
    • 任务名字
    • dependsOn
    • lockfile
  • 特殊任务名字
    • //#test - turbo run test 包含 root package.json 的 test 任务
      • 如果未在 pipeline 中定义 test 这则只运行 root 的 test 任务
turbo run build --force             # 强制 - 忽略存在缓存
turbo run dev --parallel --no-cache # 不缓存
{
  "$schema": "https://turborepo.org/schema.json",
  // hash 会用到 git 信息
  // 默认 origin/master
  "baseBranch": "origin/main",
  // 全局依赖
  "globalDependencies": ["Makefile", "package.json", "tsconfig.json", ".env"],
  "pipeline": {
    "build": {
      // 缓存内容
      // 默认 ["dist/**", "build/**"]
      "outputs": ["dist/**", "lib/**", ".next/**"],
      // 缓存依据
      // 默认 [] - 任意文件修改都会重新运行
      "inputs": ["Makefile", "package.json", "tsconfig.json", "src/**/*.ts", "src/**/*.tsx", "src/**/*.css"],
      // 缓存依赖 ENV
      "dependsOn": ["^build", "$SOME_ENV_VAR"],
      // hash-only - 只输出 hash
      // new-only - 只输出 新增
      // none - 不输出
      "outputMode": "full",
      // 是否缓存
      "cache": true
    },
    "test": {
      // 只缓存日志
      "outputs": [],
      "dependsOn": ["build"]
    },
    "dev": {
      // dev 不缓存
      "cache": false
    }
  },
  // 全局依赖
  "globalDependencies": ["$GITHUB_TOKEN", "tsconfig.json", ".env.*"]
}

turborepo-remote-cache​

Note

local 存储会添加 /tmp 前缀到 STORAGE_PATH src/plugins/remote-cache/storage/local.ts

docker run \
  -v $PWD/cache:/cache --env-file=.env \
  -p 3000:3000 \
  --name turborepo-remote-cache ducktors/turborepo-remote-cache

# npx 启动
# npx turborepo-remote-cache
# development
NODE_ENV=production
PORT=3000
TURBO_TOKEN=
LOG_LEVEL=info
# s3
STORAGE_PROVIDER=local
STORAGE_PATH=/cache
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_REGION=
S3_ENDPOINT=
# --api
turbo run build --token=$TURBO_TOKEN
.turbo/config.json
{
  "teamId": "team_FcALQN9XEVbeJ1NjTQoS9Wup",
  "apiUrl": "http://localhost:3000"
}

FAQ

error hashing files: could not hash file package-lock.json​

  • 如果从 npm 切换到了 pnpm，还需要修改 package.json 里的 packageManager

No caches are enabled​

No caches are enabled. You can try "turbo login", "turbo link", or ensuring you are not passing --remote-only to enable caching

Version

turbo 2.0​

  • 支持 watch 模式
  • 支持 交互式 命令 - 例如 dev 这种
  • node_modules/.cache -> .turbo/cache
  • package.json 要求定义 packageManager
  • pipeline -> tasks
  • 环境变量默认 Strict Mode
    • --env-mode=strict
    • 可能导致以前的环境变量不生效，可以考虑修改为 --env-mode=loose
  • 所有包默认依赖 Workspace root
npx @turbo/codemod migrate