构建仓库结构

{
  "private": true,
  "scripts": {
    "build": "turbo run build",
    "dev": "turbo run dev",
    "lint": "turbo run lint"
  },
  "devDependencies": {
    "turbo": "latest"
  },
  "packageManager": "pnpm@9.0.0"
}

根目录 `turbo.json`

turbo.json 用于配置 turbo 的行为。要了解有关如何配置任务的更多信息，请访问配置任务页面。

包管理器锁定文件

锁定文件是您的包管理器和 turbo 可重现行为的关键。此外，Turborepo 使用锁定文件来了解您的工作区中内部包之间的依赖关系。

如果您在运行 turbo 时没有锁定文件，您可能会看到不可预测的行为。

包的剖析

最好从将包设计为工作区内的独立单元开始考虑。从较高层面来看，每个包几乎就像它自己的小型“项目”，具有自己的 package.json、工具配置和源代码。这个想法有一些限制，但这是一个很好的起点心智模型。

此外，包还具有特定的入口点，工作区中的其他包可以使用这些入口点来访问该包，这些入口点由exports 指定。

包的 `package.json`

`name`

name 字段用于标识包。它在您的工作区中应该是唯一的。

最佳实践是为您的内部包使用命名空间前缀，以避免与 npm 注册表上的其他包冲突。例如，如果您的组织名为 acme，您可以将您的包命名为 @acme/package-name。

我们在文档和示例中使用 @repo，因为它是在 npm 注册表上未使用的、不可声明的命名空间。您可以选择保留它或使用您自己的前缀。

`scripts`

scripts 字段用于定义可以在包上下文中运行的脚本。Turborepo 将使用这些脚本的名称来标识要在包中运行哪些脚本（如果有）。我们在运行任务页面上详细讨论了这些脚本。

`exports`

exports 字段用于指定想要使用该包的其他包的入口点。当您想在一个包中使用另一个包中的代码时，您将从该入口点导入。

例如，如果您有一个 @repo/math 包，您可能会有以下 exports 字段

./packages/math/package.json

{
  "exports": {
    ".": "./src/constants.ts",
    "./add": "./src/add.ts",
    "./subtract": "./src/subtract.ts"
  }
}

请注意，此示例使用了即时包模式以简化操作。它直接导出 TypeScript，但您也可以选择使用编译包模式。

此示例中的 exports 字段需要现代版本的 Node.js 和 TypeScript。

这将允许您从 @repo/math 包导入 add 和 subtract 函数，如下所示

./apps/my-app/src/index.ts

import { GRAVITATIONAL_CONSTANT, SPEED_OF_LIGHT } from '@repo/math';
import { add } from '@repo/math/add';
import { subtract } from '@repo/math/subtract';

以这种方式使用 exports 提供了三个主要好处

避免桶式文件：桶式文件是重新导出同一包中其他文件的文件，为整个包创建一个入口点。虽然它们可能看起来很方便，但编译器和打包器很难处理，并且可能很快导致性能问题。
更强大的功能：与main 字段相比，exports 还具有其他强大的功能，例如条件导出。总的来说，我们建议尽可能使用 exports 而不是 main，因为它是一个更现代的选择。
IDE 自动完成：通过使用 exports 指定包的入口点，您可以确保您的代码编辑器可以为包的导出提供自动完成功能。

如果您使用的是 TypeScript，您可能不需要工作区根目录中的 tsconfig.json。包应独立指定自己的配置，通常基于工作区中单独包的共享 tsconfig.json。有关更多信息，请访问TypeScript 指南。
您要尽可能避免跨包边界访问文件。如果您发现自己编写 ../ 以从一个包转到另一个包，您可能有一个机会通过在需要它的地方安装包并将其导入到您的代码中来重新考虑您的方法。

下一步

配置工作区后，您现在可以使用包管理器将依赖项安装到您的包中。

构建仓库结构

开始使用

工作区剖析

最低要求

在 monorepo 中指定包

声明包的目录

每个包中的 `package.json`

根目录 `package.json`