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
- switch local scripts and developer docs to direct vp commands
- pin setup-vp workflows to .node-version for Node 24 consistency
- clean up lint warnings and regenerate dist artifacts
Copy file name to clipboardExpand all lines: docs/dev.md
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@
3
3
## Prerequisites
4
4
5
5
- Node.js >= 24.0.0
6
-
-pnpm (version specified in package.json: 10.18.3)
6
+
-Vite+ (`vp`) installed globally
7
7
8
8
## Setup
9
9
10
10
Install dependencies:
11
11
12
12
```bash
13
-
pnpm install
13
+
vp install
14
14
```
15
15
16
16
## Development Workflow
@@ -36,22 +36,25 @@ After making code changes, run the following commands locally:
36
36
37
37
```bash
38
38
# Format code
39
-
pnpm run format
39
+
vp fmt src test
40
40
41
-
# Lint
42
-
pnpm run lint:fix
41
+
# Lint and apply autofixes
42
+
vp lint src test --fix
43
43
44
44
# Type check
45
-
pnpm run typecheck
45
+
tsc --noEmit
46
+
47
+
# Run format, lint, and type-aware checks together
48
+
vp check
46
49
47
50
# Run tests
48
-
pnpm run test
51
+
vp test run
49
52
50
53
# Build
51
-
pnpm run build
54
+
vp pack
52
55
53
-
# Or run all at once
54
-
pnpm run all
56
+
# Or run the full local verification flow
57
+
vp check && tsc --noEmit && vp testrun && vp pack
55
58
```
56
59
57
60
**Important**: Always commit the `dist/` directory after building. The built files must be committed because GitHub Actions runs the action from the repository directly.
@@ -94,10 +97,8 @@ Runs on:
94
97
Jobs:
95
98
96
99
1.**Format-Lint-TypeCheck**
97
-
- Checks code formatting with Prettier
98
-
- Lints code with ESLint
99
-
- Type checks with TypeScript
100
-
- Runs unit tests with Vitest
100
+
- Runs `vp check` for formatting, lint, and type-aware checks
101
+
- Runs unit tests with `vp test run`
101
102
102
103
2.**Test**
103
104
- Tests the action on multiple platforms:
@@ -141,7 +142,7 @@ Tests on container environments:
141
142
Before creating a release, make sure the `dist/` directory is built and committed:
142
143
143
144
```bash
144
-
pnpm run build
145
+
vp pack
145
146
git add dist/
146
147
git commit -m "build: update dist for release"
147
148
git push
@@ -161,7 +162,7 @@ git push origin v1.2.3
161
162
When a tag matching `v[0-9]+.[0-9]+.[0-9]+` is pushed, the release workflow (`.github/workflows/release.yml`) automatically:
162
163
163
164
1. Checks out the code
164
-
2.Installs dependencies
165
+
2.Sets up `vp` and installs dependencies
165
166
3. Builds the project
166
167
4. Verifies that `dist/` is up-to-date (fails if uncommitted changes exist)
167
168
5. Creates a GitHub release with auto-generated release notes
0 commit comments