Building SuperBOL from Sources

If you build from a clone of the git repository, make sure to update submodules:

git submodule update --init --recursive

To build the LSP server and the VSCode extension from source, you need to install a few external dependencies.

  1. First, you need to install and initialize opam, the package manager for OCaml;

  2. Then you need a recent version 1 of our build tool drom. The easiest way to have it running is via the following command:

    opam pin add https://github.com/OCamlPro/drom.git

  3. Install node.js (version >=5.2.0) if it is not already installed.

  4. You can then install all remaining dependencies, and compile the LSP server along with the VSCode extension:

    make build-deps vsix-release

You should obtain a file superbol-vscode-platform.vsix in the project’s root directory. Follow the instructions at Installing the SuperBOL VSCode extension to install it in VSCode.

Footnotes

1

The version needed to build the first α release of SuperBOL is 0.9.2~dev3 (commit 63a5770).