Skip to content

Commit 4a12c26

Browse files
anthonyshewvercel[bot]
anthonyshew
and
vercel[bot]
authored
chore: Deprecate the turbo scan command (#12406)
## Summary Deprecates `turbo scan` and removes all of its implementation code. The diagnostics it ran have become irrelevant as `turbo` has evolved: - **Turbo no longer shells out to Git**, so configuring Git's FS Monitor daemon provides no benefit to `turbo` performance. - **The Turborepo daemon is no longer used for `turbo run`**, making the daemon health check unnecessary. - **Remote Cache linking should be automatic and frictionless**, not gated behind an interactive wizard. We have better flows for this now. - **The LSP check is premature** -- we don't want to actively push users toward the extension at this stage. - **Version update checks** are better handled by existing tooling (e.g. `npx @turbo/codemod update`), not an interactive prompt. Since every diagnostic `turbo scan` ran is now either obsolete or better served elsewhere, the command itself no longer provides value. ## What changed - Deleted the `turborepo-diagnostics` crate and the `commands/scan.rs` implementation. - `turbo scan` is now hidden from `--help` and prints a deprecation warning if invoked. - Documentation updated: reference page shows a deprecation callout, reference index card marked deprecated, and `turbo scan` added to the [deprecated list on the support policy page](https://turborepo.dev/docs/support-policy#deprecated). --------- Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
1 parent 281e89b commit 4a12c26

File tree

16 files changed

+16
-832
lines changed

16 files changed

+16
-832
lines changed

‎Cargo.lock‎

Lines changed: 0 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ turborepo-cache = { path = "crates/turborepo-cache" }
5555
turborepo-ai-agents = { path = "crates/turborepo-ai-agents" }
5656
turborepo-ci = { path = "crates/turborepo-ci" }
5757
turborepo-daemon = { path = "crates/turborepo-daemon" }
58-
turborepo-diagnostics = { path = "crates/turborepo-diagnostics" }
5958
turborepo-engine = { path = "crates/turborepo-engine" }
6059
turborepo-env = { path = "crates/turborepo-env" }
6160
turborepo-errors = { path = "crates/turborepo-errors" }

‎apps/docs/content/docs/reference/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ Turborepo's API reference is broken up into the following sections:
108108
/>
109109

110110
<Card
111-
title="scan"
111+
title="scan (Deprecated)"
112112
href="/docs/reference/scan"
113-
description="Enable the fastest defaults for your Turborepo."
113+
description="Deprecated. Will be removed in a future major version."
114114
/>
115115

116116
<Card

‎apps/docs/content/docs/reference/scan.mdx‎

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11
---
2-
title: scan
3-
description: API reference for the `turbo scan` command
2+
title: scan (Deprecated)
3+
description: API reference for the deprecated `turbo scan` command
44
product: turborepo
55
type: reference
6-
summary: Reference for the `turbo scan` command that interactively enables performance optimizations.
6+
summary: The `turbo scan` command has been deprecated and will be removed in a future major version.
77
---
88

9-
Enable faster tooling for your Turborepo locally with one, interactive command.
10-
11-
```bash title="Terminal"
12-
turbo scan
13-
```
14-
15-
You'll be taken through a short series of steps to enable the fastest settings for your Turborepo. These optimizations include:
16-
17-
- **Git FS Monitor**: `turbo` leans on Git to do file change discovery. Since we have to wait for `git` to tell us about changes, we can use [Git's built-in filesystem monitor](https://git-scm.com/docs/git-fsmonitor--daemon) to get those notifications sooner.
18-
- **Turborepo Daemon** (deprecated for `turbo run`): Turborepo's daemon is no longer used for `turbo run`. It is still used by `turbo watch` and the Turborepo LSP.
19-
- **Remote Caching**: While Turborepo can cache your work locally, it can also share a cache across all of your machines. Enabling [Remote Caching](/docs/core-concepts/remote-caching) makes your caching **multiplayer**, ensuring that you, your teammates, and your CI machines, never do the same work twice.
20-
- **Check `turbo` version**: We're always working towards making `turbo` better. To ensure you are using the latest version of Turborepo, we'll check your version and remind you to install `latest` if you aren't using it yet.
21-
- **Check for Turborepo LSP**:
22-
Visit the [VSCode Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=Vercel.turbo-vsc) and install the Turborepo LSP extension for your IDE.
9+
<Callout type="warn" title="Deprecated">
10+
`turbo scan` has been deprecated and will be removed in a future major version.
11+
Running it will print a deprecation warning and exit.
12+
</Callout>

‎apps/docs/content/docs/support-policy.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,4 @@ Deprecated APIs are in the process of being removed. Any feature we intend to re
120120
- `TURBO_REMOTE_ONLY` and `--remote-only`: Use [`TURBO_CACHE`](/docs/reference/system-environment-variables) or [--cache](/docs/reference/run#--cache-options)
121121
- `--scope` for [`turbo prune`](/docs/reference/prune): Use positional arguments instead (e.g. `turbo prune web`)
122122
- `--graph` with `.png`, `.jpg`, `.pdf`, or `.json` output: These formats require an external Graphviz installation and will be removed in version 3.0. Use `.svg`, `.html`, `.mermaid`, or `.dot` instead. For programmatic access to the task graph, use [`turbo query`](/docs/reference/query).
123+
- [`turbo scan`](/docs/reference/scan): This command has been removed and will be fully deleted in a future major version.

‎crates/turborepo-diagnostics/Cargo.toml‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎crates/turborepo-diagnostics/README.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)