Skip to content

Commit

Permalink
docs: boundaries experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyshew committed Jan 28, 2025
1 parent dd39a06 commit c6b0bf8
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/repo-docs/reference/boundaries.mdx
Original file line number Diff line number Diff line change
@@ -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';

<ExperimentalBadge>Experimental</ExperimentalBadge>

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

<Callout title="Boundaries RFC">
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.
</Callout>
10 changes: 10 additions & 0 deletions docs/repo-docs/reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,21 @@ Turborepo's API reference is broken up into the following sections:
description="Run tasks using `turbo`."
/>

<Card
title="watch"
href="/repo/docs/reference/watch"
description="Dependency-aware, single-process task watcher."
/>
<Card
title="prune"
href="/repo/docs/reference/prune"
description="Create partial monorepos for target workspaces."
/>
<Card
title="boundaries"
href="/repo/docs/reference/boundaries"
description="Enforce best practices in your monorepo."
/>
<Card
title="ls"
href="/repo/docs/reference/ls"
Expand Down
1 change: 1 addition & 0 deletions docs/repo-docs/reference/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"run",
"watch",
"prune",
"boundaries",
"ls",
"query",
"generate",
Expand Down

0 comments on commit c6b0bf8

Please sign in to comment.