From c6b0bf8c9b5ebd788c866ba8f8cc52de3d72e2bc Mon Sep 17 00:00:00 2001 From: Anthony Shew Date: Tue, 28 Jan 2025 14:40:48 -0700 Subject: [PATCH 1/2] docs: boundaries experimental --- docs/repo-docs/reference/boundaries.mdx | 28 +++++++++++++++++++++++++ docs/repo-docs/reference/index.mdx | 10 +++++++++ docs/repo-docs/reference/meta.json | 1 + 3 files changed, 39 insertions(+) create mode 100644 docs/repo-docs/reference/boundaries.mdx diff --git a/docs/repo-docs/reference/boundaries.mdx b/docs/repo-docs/reference/boundaries.mdx new file mode 100644 index 0000000000000..d044c27f80db6 --- /dev/null +++ b/docs/repo-docs/reference/boundaries.mdx @@ -0,0 +1,28 @@ +--- +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 caching and other Turborepo features work correctly by checking for package manager Workspace violations. + +```bash title="Terminal" +turbo boundaries +``` + +This command will notify for three types of violations: + +- Importing a file outside of the package's directory +- Importing a type without declaring the import as a type +- Importing a package that is not specified in dependencies + + + 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`." /> + + Date: Fri, 31 Jan 2025 11:25:11 -0700 Subject: [PATCH 2/2] WIP --- docs/repo-docs/reference/boundaries.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/repo-docs/reference/boundaries.mdx b/docs/repo-docs/reference/boundaries.mdx index d044c27f80db6..30b2806e5f2f2 100644 --- a/docs/repo-docs/reference/boundaries.mdx +++ b/docs/repo-docs/reference/boundaries.mdx @@ -8,17 +8,16 @@ import { Callout } from '#/components/callout'; Experimental -Boundaries ensure that caching and other Turborepo features work correctly by checking for package manager Workspace violations. +Boundaries ensure that Turborepo features work correctly by checking for package manager Workspace violations. ```bash title="Terminal" turbo boundaries ``` -This command will notify for three types of violations: +This command will notify for two types of violations: - Importing a file outside of the package's directory -- Importing a type without declaring the import as a type -- Importing a package that is not specified in dependencies +- 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