|
| 1 | +<!--VITE PLUS START--> |
| 2 | + |
| 3 | +# Vite+ Agent Notes |
| 4 | + |
| 5 | +This project uses Vite+ through the `vp` CLI. Use `vp` for package management and project tooling; do not run `npm`, `pnpm`, or Yarn directly unless the user explicitly asks. |
| 6 | + |
| 7 | +## Commands |
| 8 | + |
| 9 | +- `vp install` - install dependencies and configure Vite+ hooks. |
| 10 | +- `vp dev` - start the Vite development server. |
| 11 | +- `vp check` - run Oxfmt formatting checks, Oxlint, and TypeScript checks. |
| 12 | +- `vp lint` / `vp fmt` - run focused lint or format commands when a full check is not needed. |
| 13 | +- `vp test` - run Vitest through Vite+ when tests are present. |
| 14 | +- `vp build` - build the app with Vite+. |
| 15 | +- `vp preview` - preview a production build locally. |
| 16 | +- `vp run <script>` - run a `package.json` script when its name collides with a Vite+ built-in command. For example, use `vp run build` if you need the full `build` script plus `postbuild`. |
| 17 | + |
| 18 | +## Tooling Rules |
| 19 | + |
| 20 | +- Import Vite/Vitest utilities from `vite-plus` where applicable, for example `import { defineConfig } from "vite-plus";` and test utilities from `vite-plus/test`. |
| 21 | +- Do not install ESLint, Prettier, Vitest, Oxlint, Oxfmt, or tsdown directly; Vite+ provides the active lint, format, test, and build tooling. |
| 22 | +- Use Vite+ dependency commands such as `vp add`, `vp remove`, `vp update`, and `vp why` instead of package-manager equivalents. |
| 23 | +- Use `vp dlx` for one-off package binaries instead of `npx`, `pnpm dlx`, or `yarn dlx`. |
| 24 | +- Do not call wrapped tools as fake subcommands such as `vp vitest` or `vp oxlint`; use `vp test`, `vp lint`, and `vp fmt`. |
| 25 | +- Use `vp help`, `vp <command> --help`, or `vp --version` to confirm command options and bundled tool versions. |
| 26 | + |
| 27 | +## Review Checklist |
| 28 | + |
| 29 | +- [ ] Run `vp install` after pulling remote changes and before getting started. |
| 30 | +- [ ] Run `vp check` to validate formatting, linting, and types. |
| 31 | +- [ ] Run `vp test` only when test files exist or the change adds tests. |
| 32 | +- [ ] Run `vp build` for production-build validation. |
| 33 | +<!--VITE PLUS END--> |
0 commit comments