rescript-lang / rescript-lang/rescript-lang.org
Guide on how to create a ReScript lib for JS usage
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 1.9k
- Forks
- 260
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 17
Description
It would be great if we'd document how to set up a ReScript project, so that it is publishable on npm without any dependency to the ReScript compiler toolchain.
I know that some workflows are blocked by the fact that ReScript doesn't ship an independent precompiled stdlib / belt package, but others have reported that a rollup based workflow is also viable as well.
Would be interesting to create a dedicated page for a rollup based setup, just to bridge the gap until we see how ppl are getting along with shipping ReScript based JS libs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue's proposed Rollup-based workflow and the existing documentation structure. Create a dedicated guide explaining how to set up a ReScript project and publish JavaScript for npm without the ReScript compiler toolchain; done means the documented setup is complete and reproducible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, rollup
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100