diff --git a/docs/repo-docs/reference/boundaries.mdx b/docs/repo-docs/reference/boundaries.mdx new file mode 100644 index 0000000000000..30b2806e5f2f2 --- /dev/null +++ b/docs/repo-docs/reference/boundaries.mdx @@ -0,0 +1,27 @@ +--- +title: boundaries +description: API reference for the `turbo boundaries` command +--- + +import { ExperimentalBadge } from '#/components/experimental-badge'; +import { Callout } from '#/components/callout'; + +Experimental + +Boundaries ensure that Turborepo features work correctly by checking for package manager Workspace violations. + +```bash title="Terminal" +turbo boundaries +``` + +This command will notify for two types of violations: + +- Importing a file outside of the package's directory +- Importing a package that is not specified as a dependency in the package's `package.json` + + + This feature is experimental, and we're looking for your feedback on [the + Boundaries RFC](https://github.com/vercel/turborepo/discussions/9435). + Additionally, please provide your use cases for user-defined Boundaries to + help inform the next iteration of our design. + diff --git a/docs/repo-docs/reference/index.mdx b/docs/repo-docs/reference/index.mdx index b822e76cb3e9c..0f3465a7039c2 100644 --- a/docs/repo-docs/reference/index.mdx +++ b/docs/repo-docs/reference/index.mdx @@ -45,11 +45,21 @@ Turborepo's API reference is broken up into the following sections: description="Run tasks using `turbo`." /> + +