You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: use vp instead of vite in CLI references (#572)
Updates calls previously done to `vite` to `vp`, as well as AGENTS.md
Please double check occurrences, I might've missed some or accidentally
changed too much!
Co-authored-by: Alexander Lichter <github@lichter.io>
Supersedes #568
Co-authored-by: Alexander Lichter <github@lichter.io>
Copy file name to clipboardExpand all lines: packages/global/AGENTS.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
# Using Vite+, the Unified Toolchain for the Web
4
4
5
-
This project is using Vite+, a modern toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, and Oxfmt. Vite+ wraps these tools and package manager commands in a single, global CLI called `vite`. Vite+ is distinct from Vite, but it invokes Vite through `vite dev` and `vite build`.
5
+
This project is using Vite+, a modern toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, and Oxfmt. Vite+ wraps these tools and package manager commands in a single, global CLI called `vp`. Vite+ is distinct from Vite, but it invokes Vite through `vp dev` and `vp build`.
6
6
7
7
## Vite+ Workflow
8
8
9
-
`vite` is a global binary that handles the full development lifecycle. Run `vite help` to print a list of commands and `vite <command> --help` for information about a specific command.
9
+
`vp` is a global binary that handles the full development lifecycle. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command.
10
10
11
11
### Vite+ Commands
12
12
@@ -20,7 +20,7 @@ This project is using Vite+, a modern toolchain built on top of Vite, Rolldown,
20
20
- new - Create a new monorepo package (in-project) or a new project (global)
21
21
- run - Run tasks from `package.json` scripts
22
22
23
-
These commands map to their corresponding tools. For example, `vite dev --port 3000` runs Vite's dev server and works the same as Vite. `vite test` runs JavaScript tests through the bundled Vitest. The version of all tools can be checked using `vite --version`. This is useful when researching documentation, features, and bugs.
23
+
These commands map to their corresponding tools. For example, `vp dev --port 3000` runs Vite's dev server and works the same as Vite. `vp test` runs JavaScript tests through the bundled Vitest. The version of all tools can be checked using `vp --version`. This is useful when researching documentation, features, and bugs.
24
24
25
25
### Package Manager Commands
26
26
@@ -41,14 +41,14 @@ Vite+ automatically detects and wraps the underlying package manager such as pnp
41
41
## Common Pitfalls
42
42
43
43
-**Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations.
44
-
-**Always use Vite commands to run tools:** Don't attempt to run `vite vitest` or `vite oxlint`. They do not exist. Use `vite test` and `vite lint` instead.
45
-
-**Running scripts:** Vite+ commands take precedence over `package.json` scripts. If there is a `test` script defined in `scripts` that conflicts with the built-in `vite test` command, run it using `vite run test`.
44
+
-**Always use Vite commands to run tools:** Don't attempt to run `vp vitest` or `vp oxlint`. They do not exist. Use `vp test` and `vp lint` instead.
45
+
-**Running scripts:** Vite+ commands take precedence over `package.json` scripts. If there is a `test` script defined in `scripts` that conflicts with the built-in `vp test` command, run it using `vp run test`.
46
46
-**Do not install Vitest, Oxlint, Oxfmt, or tsdown directly:** Vite+ wraps these tools. They must not be installed directly. You cannot upgrade these tools by installing their latest versions. Always use Vite+ commands.
47
47
-**Import JavaScript modules from `vite-plus`:** Instead of importing from `vite` or `vitest`, all modules should be imported from the project's `vite-plus` dependency. For example, `import { defineConfig } from 'vite-plus';` or `import { expect, test, vi } from 'vite-plus/test';`. You must not install `vitest` to import test utilities.
48
-
-**Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vite lint --type-aware` works out of the box.
48
+
-**Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box.
49
49
50
50
## Review Checklist for Agents
51
51
52
-
-[ ] Run `vite install` after pulling remote changes and before getting started.
53
-
-[ ] Run `vite lint`, `vite fmt`, and `vite test` to validate changes.
52
+
-[ ] Run `vp install` after pulling remote changes and before getting started.
53
+
-[ ] Run `vp lint`, `vp fmt`, and `vp test` to validate changes.
0 commit comments