Skip to content

Commit bd1d5cd

Browse files
committed
docs: add development section to README and use vpx in pre-commit hook
Add developer documentation with Vite+ CLI install instructions, setup steps, available commands, and contribution guidelines. Switch pre-commit hook from npx to vpx for consistency with the Vite+ toolchain.
1 parent 9937ebf commit bd1d5cd

2 files changed

Lines changed: 33 additions & 1 deletion

File tree

.husky/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
npx lint-staged
1+
vpx lint-staged

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,38 @@ jobs:
143143
- run: vp run test
144144
```
145145

146+
## Development
147+
148+
### Install Vite+ CLI
149+
150+
- **Linux / macOS:** `curl -fsSL https://staging.viteplus.dev/install.sh | bash`
151+
- **Windows:** `irm https://staging.viteplus.dev/install.ps1 | iex`
152+
153+
### Setup
154+
155+
```bash
156+
git clone https://github.com/voidzero-dev/setup-vp.git
157+
cd setup-vp
158+
vp install
159+
```
160+
161+
### Available Commands
162+
163+
| Command | Description |
164+
| ------------------- | ------------------------ |
165+
| `vp run build` | Build (outputs to dist/) |
166+
| `vp run test` | Run tests |
167+
| `vp run test:watch` | Run tests in watch mode |
168+
| `vp run typecheck` | Type check |
169+
| `vp run check` | Lint + format check |
170+
| `vp run check:fix` | Auto-fix lint/format |
171+
172+
### Before Committing
173+
174+
- Run `vp run check:fix` and `vp run build`
175+
- The `dist/index.mjs` must be committed (it's the compiled action entry point)
176+
- Pre-commit hooks (via husky + lint-staged) will automatically run `vp check --fix` on staged files via `vpx lint-staged`
177+
146178
## Feedback
147179

148180
If you have any feedback or issues, please [submit an issue or start a discussion](https://github.com/voidzero-dev/vite-plus-discussions).

0 commit comments

Comments
 (0)