Summary: - Ran vp update -r -w for the workspace dependency refresh - Finalized the vite-plus catalog range at ^0.1.22 - Kept the Vite+ generated AGENTS block update from vp config Validation: - vp check - vp test - vp outdated --compatible --format json -r -w
Showing the changes to AGENTS.md (1 of 4 files). Show all
Unified · Split
| @@ -97,87 +97,15 @@ Wrap per [agent-loop.md](./docs/workflows/agent-loop.md). One commit per complet · 96 unmodified lines | ||
| 97 | 97 | |
| 98 | 98 | # Using Vite+, the Unified Toolchain for the Web |
| 99 | 99 | |
| 100 | −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`. | |
| 100 | +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, and it invokes Vite through `vp dev` and `vp build`. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command. | |
| 101 | 101 | |
| 102 | −## Vite+ Workflow | |
| 102 | +Docs are local at `node_modules/vite-plus/docs` or online at https://viteplus.dev/guide/. | |
| 103 | 103 | |
| 104 | −`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. | |
| 105 | − | |
| 106 | −### Start | |
| 107 | − | |
| 108 | −- create - Create a new project from a template | |
| 109 | −- migrate - Migrate an existing project to Vite+ | |
| 110 | −- config - Configure hooks and agent integration | |
| 111 | −- staged - Run linters on staged files | |
| 112 | −- install (`i`) - Install dependencies | |
| 113 | −- env - Manage Node.js versions | |
| 114 | − | |
| 115 | −### Develop | |
| 116 | − | |
| 117 | −- dev - Run the development server | |
| 118 | −- check - Run format, lint, and TypeScript type checks | |
| 119 | −- lint - Lint code | |
| 120 | −- fmt - Format code | |
| 121 | −- test - Run tests | |
| 122 | − | |
| 123 | −### Execute | |
| 124 | − | |
| 125 | −- run - Run monorepo tasks | |
| 126 | −- exec - Execute a command from local `node_modules/.bin` | |
| 127 | −- dlx - Execute a package binary without installing it as a dependency | |
| 128 | −- cache - Manage the task cache | |
| 129 | − | |
| 130 | −### Build | |
| 131 | − | |
| 132 | −- build - Build for production | |
| 133 | −- pack - Build libraries | |
| 134 | −- preview - Preview production build | |
| 135 | − | |
| 136 | −### Manage Dependencies | |
| 137 | − | |
| 138 | −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. | |
| 139 | − | |
| 140 | −- add - Add packages to dependencies | |
| 141 | −- remove (`rm`, `un`, `uninstall`) - Remove packages from dependencies | |
| 142 | −- update (`up`) - Update packages to latest versions | |
| 143 | −- dedupe - Deduplicate dependencies | |
| 144 | −- outdated - Check for outdated packages | |
| 145 | −- list (`ls`) - List installed packages | |
| 146 | −- why (`explain`) - Show why a package is installed | |
| 147 | −- info (`view`, `show`) - View package information from the registry | |
| 148 | −- link (`ln`) / unlink - Manage local package links | |
| 149 | −- pm - Forward a command to the package manager | |
| 150 | − | |
| 151 | −### Maintain | |
| 152 | − | |
| 153 | −- upgrade - Update `vp` itself to the latest version | |
| 154 | − | |
| 155 | −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. | |
| 156 | − | |
| 157 | −## Common Pitfalls | |
| 158 | − | |
| 159 | −- **Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations. | |
| 160 | −- **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. | |
| 161 | −- **Running scripts:** Vite+ built-in commands (`vp dev`, `vp build`, `vp test`, etc.) always run the Vite+ built-in tool, not any `package.json` script of the same name. To run a custom script that shares a name with a built-in command, use `vp run <script>`. For example, if you have a custom `dev` script that runs multiple services concurrently, run it with `vp run dev`, not `vp dev` (which always starts Vite's dev server). | |
| 162 | −- **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. | |
| 163 | −- **Use Vite+ wrappers for one-off binaries:** Use `vp dlx` instead of package-manager-specific `dlx`/`npx` commands. | |
| 164 | −- **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. | |
| 165 | −- **Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box. | |
| 166 | − | |
| 167 | −## CI Integration | |
| 168 | − | |
| 169 | −For GitHub Actions, consider using [`voidzero-dev/setup-vp`](https://github.com/voidzero-dev/setup-vp) to replace separate `actions/setup-node`, package-manager setup, cache, and install steps with a single action. | |
| 170 | − | |
| 171 | −```yaml | |
| 172 | −- uses: voidzero-dev/setup-vp@v1 | |
| 173 | − with: | |
| 174 | − cache: true | |
| 175 | −- run: vp check | |
| 176 | −- run: vp test | |
| 177 | −``` | |
| 178 | − | |
| 179 | −## Review Checklist for Agents | |
| 104 | +## Review Checklist | |
| 180 | 105 | |
| 181 | 106 | - [ ] Run `vp install` after pulling remote changes and before getting started. |
| 182 | −- [ ] Run `vp check` and `vp test` to validate changes. | |
| 107 | +- [ ] Run `vp check` and `vp test` to format, lint, type check and test changes. | |
| 108 | +- [ ] Check if there are `vite.config.ts` tasks or `package.json` scripts necessary for validation, run via `vp run <script>`. | |
| 109 | +- [ ] If setup, runtime, or package-manager behavior looks wrong, run `vp env doctor` and include its output when asking for help. | |
| 110 | + | |
| 183 | 111 | <!--VITE PLUS END--> |