docs: make all npx examples use the scoped @juspay/ name consistently#10
Merged
Conversation
The preview-build snippet still used bare 'npx rescript-bindgen' while every other example uses 'npx @juspay/rescript-bindgen'. Scope it too so all npx examples are consistent (after a local install npx still resolves the local bin, so it works either way; consistency avoids confusion).
commit: |
Merged
jagguji
added a commit
that referenced
this pull request
Jun 9, 2026
## Release 1.0.3 — docs-only Refreshes the npm package page README, which only updates on a new publish. ### What's included (already merged to main via #9, #10) - All `npx` examples use the scoped `@juspay/rescript-bindgen` name (consistent) — fixes the forum copy-paste failure where bare `npx rescript-bindgen` resolved a different package. - "Scope today" note clarifying the tool currently targets React component packages (general TS is on the roadmap). - `@mui/material` example pinned to a React-19-compatible version that installs cleanly. ### Release mechanics On merge, push tag `v1.0.3` → `publish-npm.yml` publishes to npm under dist-tag `latest`. No code changes — generator behavior is identical to 1.0.2.
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
Follow-up to #9. The preview-build snippet still used bare
npx rescript-bindgenwhile every other example usesnpx @juspay/rescript-bindgen. This makes all npx examples consistent.Why it matters
npx rescript-bindgen(unscoped) resolves a different package from npm — the exact trap a forum user hit. After a local install the bare bin works, but mixing the two forms in the README just reads as a mistake.Verification — every README example run verbatim via the published 1.0.2
Installed
@juspay/rescript-bindgeninto a clean project and ran each example command:--help--pkg @radix-ui/react-dialog --out generated --report--pkg react-day-picker --out generated--pkg @mui/material@7.0.0 --only Button --out generated--file <.d.ts> --stdout--dir <folder> --out generated--pkg @mui/material --out generated --reportConfirmed: every
npx @juspay/rescript-bindgen …command resolves and runs correctly.