docs(cli): npm-first README + flag wrong-arch Windows ARM64 mapping - #277
Merged
Conversation
The npm registry shows `crates/plumb-cli/README.md` as the package README on https://www.npmjs.com/package/plumb-cli. The previous version led with `cargo install plumb-cli` only, leaving npm landers with no indication the package works as an npm install. Lead with `npm i -g plumb-cli`, then list cargo / brew / curl as alternatives. Add a short "what it does" block, quick usage examples, and a docs link. Add an Intel Mac note pointing at #269. Closes audit finding B4 (https://github.com/aram-devdocs/plumb — npm page shows cargo install instead of `npm i -g`).
The workspace `keywords` defaults are useful for the library crates but land in the npm package via cargo-dist, where they're stitched together with the crates.io `categories` slugs. The result on npmjs.com mixed crates.io taxonomy (`command-line-utilities`, `development-tools`, `web-programming`) with workspace keywords — none of which an npm searcher types. Override `keywords` at the `plumb-cli` package level with five free-form, npm-friendly tags: `cli`, `linter`, `design-system`, `mcp`, `chromium`. The `categories` field stays inherited from the workspace since the slugs there are correct for crates.io. crates.io caps at 5 keywords; alphanumeric + dash + underscore only — all five pass. Closes audit finding B4 (npm-friendly tags).
cargo-dist 0.28.0 auto-expands the npm `supportedPlatforms` map with fallback target triples pointing at the wrong-arch binary. With the current `targets` list, an `aarch64-pc-windows-msvc` install silently fetches the x86_64 Windows zip — emulation works, but the user gets a slow x86_64 binary instead of an explicit "no native build" error. cargo-dist 0.28.0 has no knob to opt out of the supportedPlatforms auto-expansion. Document the issue and the fix path (extract tarball, strip the bad key from `package.json`, re-pack before `npm publish`) in the dist-workspace.toml comment so the publish-npm job's follow-up PR has the context. Refs audit finding H7. The `release.yml` strip step lands separately.
Contributor
|
All crates inherit PR #286 — chore(main): release 0.0.12Bucket: ReviewDeterminism / layering / error handling / tests / docs None of the five focus areas apply. This PR contains no Rust code — it is a pure release-please version bump with a CHANGELOG entry. No new logic, no new public API surface, no new unsafe, no new deps. Mechanical correctness checks:
Nothing to flag. The PR is mechanically correct and generated by release-please. Verdict: APPROVE |
aram-devdocs
changed the title
3 tasks
This was referenced May 8, 2026
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.
Summary
crates/plumb-cli/README.mdto lead withnpm i -g plumb-cli(the npm registry renders this file on the package page).cargo install(ci(release): re-enable x86_64-apple-darwin target post-V0 #269).keywords(command-line-utilities,development-tools,web-programming) with npm-friendly tags:cli,linter,design-system,mcp,chromium. Categories stay in thecategoriesfield (still inherited from the workspace) where they belong.dist-workspace.tomlwith a fix path. cargo-dist 0.28.0 has no opt-out knob for the auto-expandedsupportedPlatforms; the surgical fix lives in thepublish-npmjob in.github/workflows/release.yml(extract tarball, strip theaarch64-pc-windows-msvckey frompackage.json, re-pack beforenpm publish) and is intentionally deferred to a follow-up PR per the parallel-batch peer-disjoint scope.Why
From the public-surface audit. Closes audit finding B4. Refs H7 (the
release.ymlstrip step lands separately).Verification
Locally generated the npm tarball with
dist build --artifacts=global, extracted it, and confirmed thepackage.jsonissue:aarch64-pc-windows-msvcmaps toplumb-cli-x86_64-pc-windows-msvc.zip(silent wrong-arch install on Windows ARM). The cargo-dist npm installer auto-expands fallback target triples; there is nodist-workspace.tomlknob to opt out in 0.28.0.Test plan
cargo package --list -p plumb-clishowsREADME.md.cargo check -p plumb-cliclean.just validatepasses (fmt, clippy, tests, cargo-deny, determinism, agents check).just determinism-checkpasses.npm view plumb-cli readme | head -20leads withnpm i -g.npm view plumb-cli supportedPlatformsdoes not includeaarch64-pc-windows-msvc.🤖 Generated with Claude Code