VS Code Merlin Extension

🚧 This is work in progress, use at your own risk 🚧

Prerequisites

npm i -g esy
or
yarn global add esy

Producing the Extension Package

# Clone the repo
git clone [email protected]:arrowresearch/vscode-merlin.git

# Install dependencies
cd vscode-merlin
npm i

# Build from reason
npm run build

# Produce package
npm run package

# Install produced package
code --install-extension vscode-merlin-[VERSION].vsix

Usage

Bucklescript

Open any of your projects (esy/bsb/opam are supported) and any of the Reason/Ocaml file in it. Extension will start initialization, vscode will display progressbar (usually in the bottom left corner). After initialization is finished, extension should fully work.

Be mindful, that first initialization can take significant amount of time, as extension will download and compile right version of ocaml, ocaml-lsp and other dependencies. Future inits in similar project (with the same version of compiler) will be almost instant.

If extension fails to initialize for some reason, please file an issue

Esy

Update your esy.json to include ocamlformat and @opam/ocaml-lsp-server. Example:

{
  "dependencies": {
     ...
    "@opam/ocaml-lsp-server": "ocaml/ocaml-lsp:ocaml-lsp-server.opam#e5e6ebf9dcf157",
    "@opam/ocamlformat": "*",
  }
},

Opam

# Pin and install ocaml-lsp-server
opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git

# Install other dependencies if needed
opam install ocamlformat reason

Running the Extension in Development Mode

• Run npm install in this directory. This installs all necessary npm modules in both the client and server directory
• Open VS Code on this directory.
• Press Ctrl+Shift+B to compile the client and server.
• Switch to the Debug viewlet.
• Select Launch Client from the drop down.
• Run the launch config.