From e8c4761463fa7ad9b3c926ea8931fb7c9227233a Mon Sep 17 00:00:00 2001 From: JongKyung Lee Date: Wed, 7 Oct 2026 12:02:42 +0900 Subject: [PATCH] docs: clarify type-check prerequisites for vp check --- docs/guide/check.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guide/check.md b/docs/guide/check.md index f71225f9e4..4d93372552 100644 --- a/docs/guide/check.md +++ b/docs/guide/check.md @@ -6,9 +6,9 @@ `vp check` is the default command for fast static checks in Vite+. It brings together formatting through [Oxfmt](https://oxc.rs/docs/guide/usage/formatter.html), linting through [Oxlint](https://oxc.rs/docs/guide/usage/linter.html), and TypeScript type checks through [tsgolint](https://github.com/oxc-project/tsgolint). By merging all of these tasks into a single command, `vp check` is faster than running formatting, linting, and type checking as separate tools in separate commands. -When `typeCheck` is enabled in the `lint.options` block in `vite.config.ts`, `vp check` also runs TypeScript type checks through the Oxlint type-aware path powered by the TypeScript Go toolchain and [tsgolint](https://github.com/oxc-project/tsgolint). `vp create` and `vp migrate` enable both `typeAware` and `typeCheck` by default. +When both `typeAware` and `typeCheck` are enabled in the `lint.options` block in `vite.config.ts`, `vp check` also runs TypeScript type checks through the Oxlint type-aware path powered by the TypeScript Go toolchain and [tsgolint](https://github.com/oxc-project/tsgolint). `vp create` and `vp migrate` enable both `typeAware` and `typeCheck` by default. -We recommend turning `typeCheck` on so `vp check` becomes the single command for static checks during development. +We recommend turning both `typeAware` and `typeCheck` on so `vp check` becomes the single command for static checks during development. ## Usage @@ -18,7 +18,7 @@ vp check --fix # Format and run autofixers. vp check --quiet # Hide lint warnings; still report and fail on errors. vp check --no-fmt # Skip format; run lint (and type-check if enabled). vp check --no-lint # Skip lint rules; keep type-check when enabled. -vp check --no-fmt --no-lint # Type-check only (requires `typeCheck` enabled). +vp check --no-fmt --no-lint # Type-check only (requires both `typeAware` and `typeCheck` enabled). ``` ## Configuration