Skip to content

Commit 072e73b

Browse files
authored
docs: boundaries experimental page (#9834)
### Description Documenting the experimental release of Boundaries built-ins. ### Testing Instructions 👀
1 parent dfbc7e1 commit 072e73b

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: boundaries
3+
description: API reference for the `turbo boundaries` command
4+
---
5+
6+
import { ExperimentalBadge } from '#/components/experimental-badge';
7+
import { Callout } from '#/components/callout';
8+
9+
<ExperimentalBadge>Experimental</ExperimentalBadge>
10+
11+
Boundaries ensure that Turborepo features work correctly by checking for package manager Workspace violations.
12+
13+
```bash title="Terminal"
14+
turbo boundaries
15+
```
16+
17+
This command will notify for two types of violations:
18+
19+
- Importing a file outside of the package's directory
20+
- Importing a package that is not specified as a dependency in the package's `package.json`
21+
22+
<Callout title="Boundaries RFC">
23+
This feature is experimental, and we're looking for your feedback on [the
24+
Boundaries RFC](https://github.com/vercel/turborepo/discussions/9435).
25+
Additionally, please provide your use cases for user-defined Boundaries to
26+
help inform the next iteration of our design.
27+
</Callout>

docs/repo-docs/reference/index.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,21 @@ Turborepo's API reference is broken up into the following sections:
4545
description="Run tasks using `turbo`."
4646
/>
4747

48+
<Card
49+
title="watch"
50+
href="/repo/docs/reference/watch"
51+
description="Dependency-aware, single-process task watcher."
52+
/>
4853
<Card
4954
title="prune"
5055
href="/repo/docs/reference/prune"
5156
description="Create partial monorepos for target workspaces."
5257
/>
58+
<Card
59+
title="boundaries"
60+
href="/repo/docs/reference/boundaries"
61+
description="Enforce best practices in your monorepo."
62+
/>
5363
<Card
5464
title="ls"
5565
href="/repo/docs/reference/ls"

docs/repo-docs/reference/meta.json

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"run",
1212
"watch",
1313
"prune",
14+
"boundaries",
1415
"ls",
1516
"query",
1617
"generate",

0 commit comments

Comments
 (0)