-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
server: update build instructions and associated lockfiles
- Loading branch information
Showing
3 changed files
with
123 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,25 @@ | ||
| # Building and Installing | ||
|
|
||
| Begin by installing OCaml and opam, if need be - here are | ||
| [instructions](https://ocaml.org/docs/installing-ocaml) for how to do so. CN and | ||
| Cerberus currently recommend, and build with, OCaml 4.14.1, and that version was | ||
| used to generate the lockfile which this installation process relies on. (I've | ||
| also been able to work with other versions as recent as 5.1.1, but your mileage | ||
| may vary.) | ||
| [instructions](https://ocaml.org/docs/installing-ocaml) for how to do so. This | ||
| build process has been tested with OCaml 4.14.1 and 5.1.1, though other versions | ||
| are likely to work as well. | ||
|
|
||
| I recommend creating and using an opam switch to maintain an isolated dependency | ||
| installation and development environment: | ||
| With a choice of version in hand, the easiest way to build this package is with | ||
| a local opam switch, like so: | ||
| ```sh | ||
| opam switch create <switch-name> ocaml.4.14.1 | ||
| eval $(opam env --switch=<switch-name> --set-switch) | ||
| VERSION=4.14.1 # or 5.1.1 | ||
| ln -s cnlsp.opam.locked-$VERSION cnlsp.opam.locked | ||
| opam switch create . ocaml.$VERSION --locked -y | ||
| eval $(opam env) | ||
| ``` | ||
|
|
||
| Next, you need to install this project's dependencies. This project depends on | ||
| `cerberus`, `cerberus-lib`, and `cn`, which it will fetch and build from a | ||
| particular commit to their repository. However, if you have previously built | ||
| and/or installed `cn` locally, you may need to uninstall it before installing | ||
| this project's dependencies, or else your existing version may shadow the | ||
| version you're trying to install. | ||
| If this command succeeds, it should put a `cn-lsp-server` binary on your | ||
| `$PATH`, but (because the switch is local) only when you're in this directory. I | ||
| recommend choosing a location that's always available on your `$PATH` and either | ||
| copying `cn-lsp-server` to that location or symlinking to it: | ||
| ```sh | ||
| dune uninstall cn | ||
| opam remove cn | ||
| cp `which cn-lsp-server` /somewhere/on/PATH | ||
| # or | ||
| ln -s `which cn-lsp-server` /somewhere/on/PATH | ||
| ``` | ||
|
|
||
| Now, install this project's dependencies: | ||
| ```sh | ||
| opam install . --deps-only --locked -y | ||
| ``` | ||
|
|
||
| Now, you can build and install the project: | ||
| ```sh | ||
| dune build | ||
| (cd bin && dune build) | ||
| dune install | ||
| ``` | ||
|
|
||
| Assuming you're using a switch, this will install a `cn-lsp-server` into | ||
| `$OPAM_SWITCH_PREFIX/bin`. I recommend manually expanding | ||
| `$OPAM_SWITCH_PREFIX/bin` and adding it to your `$PATH` in e.g. `.zshrc`, since | ||
| that's the easiest way for a client to locate a server binary. (The earlier | ||
| `opam env` command will have done this, but only for your current shell.) | ||
|
|
||
| If you're not using a switch, you'll need to say `dune install --bindir=$(pwd)` | ||
| instead, which will install a `cn-lsp-server` binary into the current directory. | ||
| You should still ensure the binary is available on your `$PATH`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| opam-version: "2.0" | ||
| name: "cnlsp" | ||
| version: "dev" | ||
| synopsis: "CN Language Server" | ||
| description: "A language server protocol implementation for the CN language" | ||
| maintainer: "Sam Cowger" | ||
| authors: "Sam Cowger" | ||
| depends: [ | ||
| "base" {= "v0.17.1"} | ||
| "base-bigarray" {= "base"} | ||
| "base-bytes" {= "base"} | ||
| "base-domains" {= "base"} | ||
| "base-nnp" {= "base"} | ||
| "base-threads" {= "base"} | ||
| "base-unix" {= "base"} | ||
| "cerberus" {= "b9daa22"} | ||
| "cerberus-lib" {= "b9daa22"} | ||
| "cmdliner" {= "1.3.0"} | ||
| "cn" {= "b9daa22"} | ||
| "conf-findutils" {= "1"} | ||
| "conf-gmp" {= "4"} | ||
| "conf-pkg-config" {= "3"} | ||
| "cppo" {= "1.7.0"} | ||
| "csexp" {= "1.5.2"} | ||
| "dune" {= "3.16.1"} | ||
| "dune-configurator" {= "3.16.1"} | ||
| "jsonrpc" {= "1.17.0"} | ||
| "lem" {= "2022-12-10"} | ||
| "linol" {= "0.6"} | ||
| "linol-lwt" {= "0.6"} | ||
| "logs" {= "0.7.0"} | ||
| "lsp" {= "1.17.0"} | ||
| "lwt" {= "5.8.0"} | ||
| "menhir" {= "20240715"} | ||
| "menhirCST" {= "20240715"} | ||
| "menhirLib" {= "20240715"} | ||
| "menhirSdk" {= "20240715"} | ||
| "monomorphic" {= "2.1.0"} | ||
| "num" {= "1.5-1"} | ||
| "ocaml" {= "5.1.1"} | ||
| "ocaml-base-compiler" {= "5.1.1"} | ||
| "ocaml-compiler-libs" {= "v0.12.4"} | ||
| "ocaml-config" {= "3"} | ||
| "ocaml-options-vanilla" {= "1"} | ||
| "ocaml_intrinsics_kernel" {= "v0.17.1"} | ||
| "ocamlbuild" {= "0.15.0"} | ||
| "ocamlfind" {= "1.9.6"} | ||
| "ocamlgraph" {= "2.1.0"} | ||
| "ocplib-endian" {= "1.2"} | ||
| "parsexp" {= "v0.17.0"} | ||
| "pprint" {= "20230830"} | ||
| "ppx_derivers" {= "1.2.1"} | ||
| "ppx_deriving" {= "6.0.3"} | ||
| "ppx_deriving_yojson" {= "3.9.0"} | ||
| "ppx_sexp_conv" {= "v0.17.0"} | ||
| "ppx_yojson_conv_lib" {= "v0.17.0"} | ||
| "ppxlib" {= "0.33.0"} | ||
| "ppxlib_jane" {= "v0.17.0"} | ||
| "result" {= "1.5"} | ||
| "seq" {= "base"} | ||
| "sexplib" {= "v0.17.0"} | ||
| "sexplib0" {= "v0.17.0"} | ||
| "sha" {= "1.15.4"} | ||
| "stdlib-shims" {= "0.3.0"} | ||
| "topkg" {= "1.0.7"} | ||
| "trace" {= "0.8"} | ||
| "uutf" {= "1.0.3"} | ||
| "yojson" {= "2.2.2"} | ||
| "zarith" {= "1.14"} | ||
| ] | ||
| build: [ | ||
| ["dune" "subst"] {dev} | ||
| [ | ||
| "dune" | ||
| "build" | ||
| "-p" | ||
| name | ||
| "-j" | ||
| jobs | ||
| "@install" | ||
| "@runtest" {with-test} | ||
| "@doc" {with-doc} | ||
| ] | ||
| ] | ||
| pin-depends: [ | ||
| [ | ||
| "cerberus.b9daa22" | ||
| "git+https://github.com/rems-project/cerberus.git#b9daa22" | ||
| ] | ||
| [ | ||
| "cerberus-lib.b9daa22" | ||
| "git+https://github.com/rems-project/cerberus.git#b9daa22" | ||
| ] | ||
| [ | ||
| "cn.b9daa22" | ||
| "git+https://github.com/rems-project/cerberus.git#b9daa22" | ||
| ] | ||
| ] |