Skip to content

docs: add the generated Vite+ block, and correct the bare-vp claim - #145

Merged
wormeyman merged 1 commit into
mainfrom
docs-vite-plus-block
Aug 4, 2026
Merged

docs: add the generated Vite+ block, and correct the bare-vp claim#145
wormeyman merged 1 commit into
mainfrom
docs-vite-plus-block

Conversation

@wormeyman

Copy link
Copy Markdown
Collaborator

Adds Vite+'s generated toolchain block to CLAUDE.md between its own HTML comment markers so the tool can resync it, with a repo-specific override note outside the markers.

There is no AGENTS.md in this repo; CLAUDE.md is the project instruction file, so it goes there.

Where this repo overrides the block

The generated checklist says to run vp install / vp check / vp test directly. This repo runs everything through pnpm, so the note points at pnpm vp <cmd> — the form package.json and CI use, and therefore the only one that stays verified — and steers vp install to pnpm install, because the install discipline here is specific: pnpm add -w for root deps, always followed by a bare pnpm install, and a 24-hour release-age guard that must not be bypassed.

Adding it surfaced a stale claim that would have contradicted it

CLAUDE.md said a bare vp or npx vp at the project root fails with EBADDEVENGINES. Half of that is wrong — measured, not assumed:

command result
npx vp check EBADDEVENGINES … Invalid name "pnpm" does not match "npm"
vp check exits 0 — "All 367 files are correctly formatted"

The global vp binary is v0.2.7 and is not npm, so the devEngines.packageManager pin does not gate it. Left as-is, an agent reading the new block ("run vp check") against the old line ("a bare vp fails") would have had no way to resolve the conflict. The line now says which form fails, which doesn't, and not to "fix" a working command on the strength of the note.

One deliberate detail

The override paragraph does not reproduce the marker strings literally. A resync that matches on marker text would otherwise find the prose before the real block and rewrite the wrong region — it points at a grep instead. Confirmed: exactly two literal markers in the file.

Verification

pnpm run verify green — 1554 app + 13 worker + 3 container tests, 0 warnings, exit 0. Documentation only.

🤖 Generated with Claude Code

https://claude.ai/code/session_012VRsPwmSwjnFKVSS6jx9Mo

Adds Vite+'s generated toolchain block to CLAUDE.md between its own HTML
comment markers, so the tool can resync it, with a short repo-specific
override note OUTSIDE the markers.

Two things worth knowing about how it landed.

The block's checklist says to run `vp install` / `vp check` / `vp test`
directly. This repo's own guidance says to run everything through pnpm, so the
note points at `pnpm vp <cmd>` - the form package.json and CI use, and
therefore the only one that stays verified - and steers `vp install` to
`pnpm install`, because the install discipline here is specific: `pnpm add -w`
for root deps, always followed by a bare `pnpm install`, and a 24-hour
release-age guard that must not be bypassed.

And adding it surfaced a stale claim that would have contradicted it. CLAUDE.md
said a bare `vp` OR `npx vp` at the project root fails with EBADDEVENGINES.
Half of that is wrong, measured rather than assumed:

  npx vp check  -> EBADDEVENGINES, Invalid name "pnpm" does not match "npm"
  vp check      -> exits 0, "All 367 files are correctly formatted"

The global `vp` binary is v0.2.7 and is not npm, so devEngines' packageManager
pin does not gate it. The line now says which form fails and which does not,
and says not to "fix" a working command on the strength of the note.

The override paragraph deliberately does NOT reproduce the marker strings
literally - a resync matching on marker text would otherwise find the prose
first and rewrite the wrong region. It points at a grep instead.

Verification: pnpm run verify green - 1554 app + 13 worker + 3 container
tests, 0 warnings, exit 0. Documentation only.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012VRsPwmSwjnFKVSS6jx9Mo
@wormeyman
wormeyman merged commit 56e4306 into main Aug 4, 2026
6 checks passed
@wormeyman
wormeyman deleted the docs-vite-plus-block branch August 4, 2026 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant