Repository navigation
docs: run Vite+ through pnpm exec - #90
Conversation
vp is the pinned vite-plus devDependency, not a global install, so a fresh checkout has no vp on PATH. Setup now runs pnpm install, and the guides call pnpm exec vp. The live examples call node dist/rokit.mjs, since rokit's own bin is not linked into node_modules/.bin.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
It is a low-risk, docs-only change whose updated commands were verified consistent with package.json bin/scripts and with the rest of the repository's documentation.
Review effort: Balanced
Findings: None
What changed in this PR
This PR updates the contributor (CONTRIBUTING.md) and agent (AGENTS.md) guides so the documented commands work from a fresh checkout without a global Vite+ install. Previously, bare vp install failed with command not found because vp is only the pinned vite-plus devDependency, and vp exec rokit failed because the package's own rokit bin is not self-linked into node_modules/.bin within the dev repo. The changes align the docs with the actual conventions already used by package.json scripts.
Changes:
- Setup now uses
pnpm install, and every local script invocation is prefixed withpnpm exec vp run <script>. - Live Roku example commands use
node dist/rokit.mjs ...(matchingbin.rokitand the package scripts) instead ofvp exec rokit ..., with a clarifying note thatlive:smokebuilds this CLI.
| File | Description |
|---|---|
| CONTRIBUTING.md | Switches setup/validation/live-check commands to pnpm install, pnpm exec vp run ..., and node dist/rokit.mjs |
| AGENTS.md | Updates the Checks and live-command sections to pnpm exec vp/node dist/rokit.mjs and adds a note clarifying Vite+ invocation and that live:smoke builds the CLI |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Summary
The contributor and agent guides now work from a fresh checkout without a global Vite+ install.
vpis the pinnedvite-plusdevDependency, so barevp installfailed withcommand not found.Changed
pnpm install; every local command ispnpm exec vp run <script>.node dist/rokit.mjsinstead ofvp exec rokit, which failed even withvpavailable: rokit's own bin is not linked intonode_modules/.bin.vp run verify; CI installsvpwithsetup-vp.Risks
None beyond docs. Live Roku commands were not run.
Verification
vp: barevp installexits 127;pnpm installthenpnpm exec vp run verifypasses (165 tests).pnpm exec vp run check,typecheck,smoke,testandskills:lintpass.node dist/rokit.mjs --dry-run press Info Backexits 0;pnpm exec vp exec rokit ...exits 1 withCommand 'rokit' not found in node_modules/.bin.Written by an agent (Claude Code, Opus 5.5)