rescript-lang/rescript-lang.org

Guide on how to create a ReScript lib for JS usage

Open

#174 opened on Jan 5, 2021

View on GitHubContributor guide
 (6 comments) (3 reactions) (0 assignees)MDX (258 forks)github user discovery
help wantedmanual

Repository metrics

Stars
 (1,855 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Create a step by step guide on setting up a ReScript project with rollup for npm publishing, including configuration and workflow.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReScriptnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60