Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: boundaries experimental page #9834

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/repo-docs/reference/boundaries.mdx
Original file line number Diff line number Diff line change
@@ -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';

<ExperimentalBadge>Experimental</ExperimentalBadge>

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`

<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
Loading