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: CLAUDE.md
+6-79Lines changed: 6 additions & 79 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,89 +87,16 @@ Tests use Vitest with:
87
87
88
88
# Using Vite+, the Unified Toolchain for the Web
89
89
90
-
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`.
91
-
92
-
## Vite+ Workflow
93
-
94
-
`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.
95
-
96
-
### Start
97
-
98
-
- create - Create a new project from a template
99
-
- migrate - Migrate an existing project to Vite+
100
-
- config - Configure hooks and agent integration
101
-
- staged - Run linters on staged files
102
-
- install (`i`) - Install dependencies
103
-
- env - Manage Node.js versions
104
-
105
-
### Develop
106
-
107
-
- dev - Run the development server
108
-
- check - Run format, lint, and TypeScript type checks
109
-
- lint - Lint code
110
-
- fmt - Format code
111
-
- test - Run tests
112
-
113
-
### Execute
114
-
115
-
- run - Run monorepo tasks
116
-
- exec - Execute a command from local `node_modules/.bin`
117
-
- dlx - Execute a package binary without installing it as a dependency
118
-
- cache - Manage the task cache
90
+
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.
119
91
120
-
### Build
92
+
Docs are local at `node_modules/vite-plus/docs` or online at https://viteplus.dev/guide/.
121
93
122
-
- build - Build for production
123
-
- pack - Build libraries
124
-
- preview - Preview production build
125
-
126
-
### Manage Dependencies
127
-
128
-
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.
129
-
130
-
- add - Add packages to dependencies
131
-
- remove (`rm`, `un`, `uninstall`) - Remove packages from dependencies
132
-
- update (`up`) - Update packages to latest versions
133
-
- dedupe - Deduplicate dependencies
134
-
- outdated - Check for outdated packages
135
-
- list (`ls`) - List installed packages
136
-
- why (`explain`) - Show why a package is installed
137
-
- info (`view`, `show`) - View package information from the registry
138
-
- link (`ln`) / unlink - Manage local package links
139
-
- pm - Forward a command to the package manager
140
-
141
-
### Maintain
142
-
143
-
- upgrade - Update `vp` itself to the latest version
144
-
145
-
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.
146
-
147
-
## Common Pitfalls
148
-
149
-
-**Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations.
150
-
-**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.
151
-
-**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).
152
-
-**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.
153
-
-**Use Vite+ wrappers for one-off binaries:** Use `vp dlx` instead of package-manager-specific `dlx`/`npx` commands.
154
-
-**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.
155
-
-**Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box.
156
-
157
-
## CI Integration
158
-
159
-
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.
160
-
161
-
```yaml
162
-
- uses: voidzero-dev/setup-vp@v1
163
-
with:
164
-
cache: true
165
-
- run: vp check
166
-
- run: vp test
167
-
```
168
-
169
-
## Review Checklist for Agents
94
+
## Review Checklist
170
95
171
96
-[ ] Run `vp install` after pulling remote changes and before getting started.
172
-
- [ ] Run `vp check` and `vp test` to validate changes.
97
+
-[ ] Run `vp check` and `vp test` to format, lint, type check and test changes.
98
+
-[ ] Check if there are `vite.config.ts` tasks or `package.json` scripts necessary for validation, run via `vp run <script>`.
0 commit comments