Skip to content

docs: run project commands through vp - #3679

Merged
afonsojramos merged 1 commit into
mainfrom
docs/vp-commands
Nov 11, 2026
Merged

afonsojramos merged 1 commit into
mainfrom
docs/vp-commands

Conversation

@afonsojramos

@afonsojramos afonsojramos commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Documents and runs every project command through the Vite+ CLI, following #3673 and #3678.

Changes

  • README.md, CONTRIBUTING.md and .github/copilot-instructions.md use vp install, vp run <script> and vp exec tsc --noEmit instead of pnpm. Each now asks contributors to install the Vite+ CLI, which downloads the pnpm version pinned in devEngines.
  • The i18n:check and i18n:lint steps in lint.yml use vp run, like the rest of the workflow.
  • The Husky pre-commit hook runs vp staged directly. Husky puts node_modules/.bin on PATH, so it does not need a global vp.
  • .github/copilot-instructions.md keeps only guidance an agent cannot read from the repository: setup, the main commands, the pre-finish checks, two gotchas, and the project philosophy. It drops the file map and version list (covered by ARCHITECTURE.md and package.json) and stale claims: Node 24, a separate tsc step (vp run check type-checks), pre-existing lint warnings, timezone snapshot drift (vitest.config.mts forces TZ=UTC), and a wrong codegen output path. It also lists GitLab.
  • Code comments that named pnpm <script> commands now name vp run <script>.

Mentions of pnpm itself (the store, lockfile, pnpm list in the packaging check, and the visual test container in scripts/visual.sh) are unchanged, because pnpm remains the package manager underneath vp install.

Testing

  • vp install --frozen-lockfile uses pnpm 12.18.0 and finds the lockfile up to date.
  • vp exec tsc --noEmit passes.
  • vp run test -u passes -u through to Vitest; all 2194 tests pass and no snapshots change.
  • The pre-commit hook ran vp staged on this commit.
  • vp run check passes.

@afonsojramos
afonsojramos requested a review from setchy as a code owner November 11, 2026 14:37
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 11, 2026
@sonarqubecloud

Copy link
Copy Markdown

@afonsojramos
afonsojramos merged commit dd0d249 into main Nov 11, 2026
19 checks passed
@afonsojramos
afonsojramos deleted the docs/vp-commands branch November 11, 2026 15:14
@github-actions github-actions Bot added this to the Release 8.2.0 milestone Nov 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

1 participant