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
Copy file name to clipboardExpand all lines: AGENTS.md
+77Lines changed: 77 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -422,3 +422,80 @@ Before committing or submitting PR:
422
422
4.`cargo test` (all tests pass)
423
423
5.`pnpm test` (SDK tests pass, if applicable)
424
424
6. Verify no secrets in changed files (`.env`, credentials)
425
+
426
+
<!--VITE PLUS START-->
427
+
428
+
# Using Vite+, the Unified Toolchain for the Web
429
+
430
+
This project is using Vite+, a unified toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task. Vite+ wraps runtime management, package management, and frontend tooling in a single global CLI called `vp`. Vite+ is distinct from Vite, but it invokes Vite through `vp dev` and `vp build`.
431
+
432
+
## Vite+ Workflow
433
+
434
+
`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.
435
+
436
+
### Start
437
+
438
+
- create - Create a new project from a template
439
+
- migrate - Migrate an existing project to Vite+
440
+
- config - Configure hooks and agent integration
441
+
- staged - Run linters on staged files
442
+
- install (`i`) - Install dependencies
443
+
- env - Manage Node.js versions
444
+
445
+
### Develop
446
+
447
+
- dev - Run the development server
448
+
- check - Run format, lint, and TypeScript type checks
449
+
- lint - Lint code
450
+
- fmt - Format code
451
+
- test - Run tests
452
+
453
+
### Execute
454
+
455
+
- run - Run monorepo tasks
456
+
- exec - Execute a command from local `node_modules/.bin`
457
+
- dlx - Execute a package binary without installing it as a dependency
458
+
- cache - Manage the task cache
459
+
460
+
### Build
461
+
462
+
- build - Build for production
463
+
- pack - Build libraries
464
+
- preview - Preview production build
465
+
466
+
### Manage Dependencies
467
+
468
+
Vite+ automatically detects and wraps the underlying package manager such as pnpm, npm, or Yarn through the `packageManager` field in `package.json` or package manager-specific lockfiles.
469
+
470
+
- add - Add packages to dependencies
471
+
- remove (`rm`, `un`, `uninstall`) - Remove packages from dependencies
472
+
- update (`up`) - Update packages to latest versions
473
+
- dedupe - Deduplicate dependencies
474
+
- outdated - Check for outdated packages
475
+
- list (`ls`) - List installed packages
476
+
- why (`explain`) - Show why a package is installed
477
+
- info (`view`, `show`) - View package information from the registry
478
+
- link (`ln`) / unlink - Manage local package links
479
+
- pm - Forward a command to the package manager
480
+
481
+
### Maintain
482
+
483
+
- upgrade - Update `vp` itself to the latest version
484
+
485
+
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.
486
+
487
+
## Common Pitfalls
488
+
489
+
-**Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations.
490
+
-**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.
491
+
-**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`.
492
+
-**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.
493
+
-**Use Vite+ wrappers for one-off binaries:** Use `vp dlx` instead of package-manager-specific `dlx`/`npx` commands.
494
+
-**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.
495
+
-**Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box.
496
+
497
+
## Review Checklist for Agents
498
+
499
+
-[ ] Run `vp install` after pulling remote changes and before getting started.
500
+
-[ ] Run `vp check` and `vp test` to validate changes.
0 commit comments