docs(install): document pnpm, Yarn and bun alongside npm - #51
Merged
Merged
Conversation
@pgbot/cli already installs cleanly under every Node package manager — the wrapper resolves the binary at run time and the package ships no lifecycle scripts — but the docs named only npx, so bun and pnpm users had no signal it was supported. Adds a no-install/project/global matrix for npm, pnpm, Yarn and bun to the Install section and to the npm package README, and notes the two Yarn wrinkles: `yarn dlx` is Berry-only, and Berry's PnP linker has no node_modules/.bin, so the command is `yarn pgbot`. Verified against the published 0.8.1 with npm 10.9, pnpm 9.12, Yarn 1.22, Yarn 4.5 (PnP) and bun 1.4.2; each fetched only @pgbot/darwin-arm64.
1 task
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.
@pgbot/clialready installs cleanly under every Node package manager, but the docs named onlynpx— so a bun or pnpm user had no signal it was supported. This is a docs-only change; no packaging or wrapper code moves.What changed
README.md— a no-install / project / global matrix for npm, pnpm, Yarn and bun in the Install section, and the table's no-install row is relabellednpx / bunx / pnpm dlx.npm/pgbot/README.md— the same matrix, plus the scoped-nameE404note that previously lived only in the main README.Both call out why it works everywhere: the wrapper locates the binary at run time and the package ships no lifecycle scripts, so it survives
npm ci --ignore-scripts, pnpm's blocked-by-default builds, and bun. Two Yarn wrinkles are documented —yarn dlxis Berry-only, and Berry's PnP linker has nonode_modules/.bin, so the invocation isyarn pgbot.Verification
Installed the published
@pgbot/cli@0.8.1from the real registry with each manager; every path printedpgbot version 0.8.1.Each install fetched only
@pgbot/darwin-arm64— theos/cpufields written bynpm/build.mjsare honored by all four resolvers, so nobody pulls six binaries.Follow-up worth considering
npm/test/pack-smoke.shexercises npm only. A wrapper change could quietly break bun or Yarn PnP without CI noticing — extending that smoke test to the other managers would close the gap. Not in this PR.