docs(standards): Bun everywhere — commands, prerequisites, and a page of its own - #3
Open
dmitriyzhuk wants to merge 1 commit into
Open
dmitriyzhuk wants to merge 1 commit into
dmitriyzhuk wants to merge 1 commit into
Conversation
… of its own Every install line on the site said `npm install`, every CLI line said `npx`, and two pages had wandered into `pnpm`. The projects these pages describe build with Bun, so the site was teaching a setup nobody runs. All of it now reads `bun install` / `bun add` / `bun run` / `bunx`, the Getting Started prerequisites name Bun first, and `/standards/bun` states the rule with the command map and the two traps: pre-scripts still run under Bun (`predev` is load-bearing in CleanSlice), and a Docker build belongs in a NODE image with the Bun binary copied in — `oven/bun` ships a `node` shim, under which `nest build` stops rewriting `#slice` aliases and the api dies on boot. The migration note is there for the same reason it cost time here: run `bun install` while `package-lock.json` is still present so Bun carries the resolved versions over, and only then delete it. Verified with `bun install` and `bun run build` (VitePress build passes, no dead links). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Every install and CLI line on the docs site now says Bun, and
/standards/bunstates the rule in one place.Companion PRs (same change, other repos):
Why
The site said
npm installon every setup page,npxon every CLI line, and two pages had wandered intopnpm. The projects these pages describe build with Bun — so the documentation described a setup nobody runs, and anyone following it ended up with a second lockfile.Changed
bun install/bun add/bun add -d/bun run/bunx./standards/bun(Standards sidebar) — command map, lockfile policy, migration recipe, and the two traps below.bun.lockreplacespackage-lock.json.The two traps, both learned the hard way
Docker: Bun installs, Node builds.
oven/bunships a shim namednode, sonest buildruns under Bun there and Nest's tsconfig-paths hook stops rewriting#slicealiases — the image builds clean and the api dies on boot withCannot find module '#setup/prisma'. The page shows the working shape: a Node base with the Bun binary (and abunxsymlink) copied in.Migrating a lockfile: run
bun installwhilepackage-lock.jsonis still there so Bun carries the resolved versions over, and delete it afterwards. Deleting first re-resolves every range — in the MCP repo that pulled azodmajor and broke the build.Verified
bun install+bun run build— VitePress build passes, no dead links, new page renders in the Standards section.🤖 Generated with Claude Code