Powered by the versatile OCaml type system, with best-in-class type inference, Melange produces robust JavaScript code.

• Melange
  • Installation
    • OPAM
    • Esy
    • Nix
    • OCaml version compatibility
  • Editor integration
  • Community
  • FAQ
    • How does this project relate to other tools?
  • Contributing
  • Acknowledgments
  • Licensing

Sponsored by:

Melange is released to OPAM. Install it with:

$ opam install melange

melange-re/melange-opam-template provides a GitHub template repository that can be used as a project starter.

Melange has good support for Nix:

• github:melange-re/melange can be added as a flake input
• the melange flake provides a melange.overlays.default overlay that adds melange to pkgs.ocamlPackages.melange
• the melc binary can be run with nix run github:melange-re/melange, e.g. nix run github:melange-re/melange/1.0.0 -- --help

Get Esy on NPM:

• npm install -g esy installs Esy globally
• if npm is installed, npx esy can be used to run Esy locally

An Esy project starter also exists.

After cloning the template, run esy in the project root.

Melange >= v1.0 can build projects on OCaml >= 4.13 (including OCaml 5.x). Editor integration only works on OCaml 4.14, because Melange emits .cmt artifacts targeting the OCaml 4.14 binary format.

Melange has first class support in Dune. ocaml-lsp or Merlin works as usual. In VSCode, the VSCode OCaml Platform extension is recommended.

• There's a #melange channel in the ReasonML Discord

This project is forked from the ReScript compiler, focused on a deeper integration with the OCaml ecosystem. This allows sharing code between backend and frontend using Dune's virtual libraries.

Melange also introduces a ReScript compatibility layer to maintain compatibility with ReScript syntax - preserving access to ReScript's package ecosystem. It's only recommended to use it with Melange v1, as both ReScript and Melange have diverged significantly since then.

A small write-up with more details on the motivation behind this project can be found in the announcement blog post.

Below is a quick comparison between Melange and other tools:

See CONTRIBUTING.md.

• Thanks to the ReScript project, its author and maintainer @bobzhang, and its many contributors. Melange is a fork of ReScript, and continues to incorporate patches to ReScript on a regular basis.
• Thanks to the OCaml team, obviously, without such a beautiful yet practical language, this project would not exist.
• Thanks to Bloomberg and Facebook. The ReScript project began at Bloomberg and was published in 2016; without the support of Bloomberg, it would not have happened. ReScript was funded by Facebook since July 2017.

See also Credits.md concerning some individual components of Melange.

See COPYING and COPYING.LESSER

See Credits for more details.