(unsure whether this is the right repo to post this issue on)

When I ask for autocompletion, I get a list of items that seem unrelated/invalid for the thing I'm currently autocompleting. Here's an example:

I only expect to see myThing here since y is of type x and that's the only thing available on x.

This becomes a bit more problematic when multiple language servers (for multiple languages) are active in the same document. Here's an example of that:

Here's a GraphQL operation defined inside of a string. There's a separate GraphQL language server running and providing autocomplete for that snippet, but its items are pushed to the very bottom of the list by all of the other unrelated/invalid items. Since it's inside of a string I was expecting to get no completion at all from ocamllsp/merlin. What I was expecting to see was this:

....which comes from the GraphQL LS, and is indeed available in the list, but at the very bottom.

So, I guess my question is, is there a way to get rid of the unrelated items and only get a list of things I can actually use in the place where I'm autocompleting?

Reason support was added recently, it works quite well included, what's missing now is to support refmt instead of ocamlformat for Reason files.

If it's not too complicated, I can try my luck on it, any pointer will be appreciated :)

codeActionsKinds should be codeActionKinds (without s).

send: {
   ....
  "result": {
    "capabilities": {
     ....
      "codeActionProvider": { "codeActionsKinds": [ "destruct" ] },
     ....
    }
  }
}

TT types didn't save us :(

The last field of the Intialize.TextDocumentSyncOptions is named didSave in the current code, but it seems to be named simply save in the specification if I'm not mistaken (cf https://microsoft.github.io/language-server-protocol/specifications/specification-3-14/ ).

A bit of context: I'm not sure it is a problem, but I'm trying to find out why my lsp server does not seems to receive didSave notifications, and this would seem to be a likely candidate (since according to the spec, if the save field is omitted (o in this case misnamed), such notifications will not be sent).

I'm sorry about all these issues and if you prefer, I can stop posting them until #87 is merged, ^^

Hi, I have follow the instruction for opam and installed it for MacOS.

However, I cannot find the executable and it cannot be detected by emacs lsp-mode as well. Do I need to take extra step to link the executable?

Currently, build of ocaml-lsp fails with duen 2 requiring dune 1.x. Are there plan to support dune 2?

For demonstration, with the following code,

let x ?(a=1) b: bool = a + b > 0
let y = x ~a:3 5

ocaml-lsp gives me bool, i.e., the result type of x when I put a cursor on ~a: part, but I think it is bit misleading and it would be better to give int, i.e., the type of the a argument.

I use this server with lsp-mode as a client.
When I choose a completed word in a completion list, ocaml-lsp spend a few seconds (or sometime, dozens of seconds) before it really completes the word.
It used to not spend such a long time, and other lsp servers like haskell-ide-engine and metals don't.

I don't know what version I used before completion became slow, but now I use OCaml 4.09.0 with 8e03749 and OCaml 4.07.1 with 0fedbda

Could you please inspect this issue?

Lsp.Rpc.start state handler ic oc; could have a catch all + logging, so that a stray failwith or invalid_arg doesn't kill the whole thing?
cc @Gbury

We don't actually need findlib for anything as we only support dune generated .merlin files and those don't use the PKG field.

Let's stick to dependencies that can be built with dune in this project.

I'm trying out ocaml-lsp with https://github.com/ocamllabs/vscode-ocaml-platform, and I can't get completion for modules defined in the same file, hovering also does not work, but when trying completion for Base., it works well and shows me everything. Hovering over Random also gives the signature. Is there some additional configuration required? dune 2.2.0, OCaml 4.06.1, .merlin files are in place.

Emacs' lsp-mode support remote LSP servers via TRAMP. Unfortunately, ocaml-lsp comes with :remote? nil by default.

I tried adding a new configuration with remote? t

(lsp-register-client
 (make-lsp-client
  :new-connection
  (lsp-tramp-connection "ocamllsp")
  :major-modes '(caml-mode tuareg-mode)
  :remote? t
  :priority 0
  :server-id 'ocaml-lsp-server-remote))

And lsp-mode actually managed to start ocamllsp on remote machine, but kind of not completely as the lsp server didn't advertise any capabilities to the client:

 `-[-] ocaml-lsp-server-remote:88874 status:starting
    |-[-] Buffers
    |  `-[+] Tenv.ml
    `-[+] Capabilities

So, I was wondering if this is something you already looked into? Or is it even the right repo to ask this question?

Current type mismatch message is hard to parse, e.g., on VS Code

and, especially, with larger types.

What do people think about a shorter (and formatted with markdown) message? For example, Intellij IDEA for Scala:

and

(might not be the best place to fix an error message, but this project seems more flexible to changes)

I could work on this if people like the idea.

the spec doesn't seem to say anything about the order of patches in DocumentEdit, so it seems safer to sort them by increasing position (stable sort, to handle the ones with same start pos) and apply them in a fold_right?

this function seems really useful for building any kind of LSP so I think it's good to provide good defaults :)

I have the same error locally (archlinux with esy) as on Travis: https://travis-ci.com/ocaml/ocaml-lsp/jobs/280940293

error: build failed with exit code: 1
  build log:
    # esy-build-package: building: @opam/ocaml-lsp-server@github:ocaml/ocaml-lsp:ocaml-lsp-server.opam#85f8c566a87fde2ce962e81432705bfaec9d581c
    # esy-build-package: pwd: /home/thomas/.esy/3/b/opam__s__ocaml_lsp_server-3a154f8b
    # esy-build-package: running: 'dune' 'build' '-j' '4' '--root' '.' '--ignore-promoted-rules' '--no-config' '--profile' 'release' 'ocaml-lsp-server.install'
    File "vendor/merlin/src/ocaml/preprocess/parser_raw.ml", line 5, characters 2-42:
    5 |   MenhirLib.StaticVersion.require_20190924
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    Error: Unbound value MenhirLib.StaticVersion.require_20190924
    error: command failed: 'dune' 'build' '-j' '4' '--root' '.' '--ignore-promoted-rules' '--no-config' '--profile' 'release' 'ocaml-lsp-server.install' (exited with 1)
    esy-build-package: exiting with errors above...
    
  building @opam/ocaml-lsp-server@github:ocaml/ocaml-lsp:ocaml-lsp-server.opam#85f8c566a87fde2ce962e81432705bfaec9d581c

I'm building with OCaml 4.08

This disables formatting on clients that interpret the capability.

This appears to be a introduced by: 7860a87.

The emacs lsp-mode package sends a lot of very granular text change notifications (emacs-lsp/lsp-mode#362). Other lsp servers apparently batch these notifications and send diagnostics asynchronously (emacs-lsp/lsp-mode#362 (comment)). ocaml-lsp should probably do the same.

Right now it looks like the type checker runs for every change?

I've looked at implementing this, but I'm not sure how to fit it in with the existing code.

When hovering over a word in a string that is a correct name of a typable entity (variable name, function name or constructor), the pop up gives the type of the entity, even if completely unrelated.
Several examples :

In last issue #36 @rgrinberg fixed initialization of the server from QtCreator side but after that something has become broken

If QtCreator sends

Content-Length: 679

{"id":"{a081f281-8313-4003-9dde-54476f6304d8}","jsonrpc":"2.0","method":"initialize","params":{"capabilities":{"textDocument":{"codeAction":{"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["*"]}}},"completion":{"completionItem":{},"completionItemKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]},"dynamicRegistration":true},"documentSymbol":{"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]}},"synchronization":{"didSave":true,"dynamicRegistration":true,"willSave":true,"willSaveWaitUntil":false}},"workspace":{"workspaceFolders":true}},"processId":28419,"rootUri":null,"trace":"off"}}

I get in the log error string_of_yojson: string needed. I don't know yet where does it happen. Full merlin log below.

# 0.01 lsp - debug
recv: {
  "id": "{a081f281-8313-4003-9dde-54476f6304d8}",
  "jsonrpc": "2.0",
  "method": "initialize",
  "params": {
    "capabilities": {
      "textDocument": {
        "codeAction": {
          "codeActionLiteralSupport": {
            "codeActionKind": { "valueSet": [ "*" ] }
          }
        },
        "completion": {
          "completionItem": {},
          "completionItemKind": {
            "valueSet": [
              1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
              19, 20, 21, 22, 23, 24, 25
            ]
          },
          "dynamicRegistration": true
        },
        "documentSymbol": {
          "symbolKind": {
            "valueSet": [
              1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
              19, 20, 21, 22, 23, 24, 25, 26
            ]
          }
        },
        "synchronization": {
          "didSave": true,
          "dynamicRegistration": true,
          "willSave": true,
          "willSaveWaitUntil": false
        }
      },
      "workspace": { "workspaceFolders": true }
    },
    "processId": 28419,
    "rootUri": null,
    "trace": "off"
  }
}
# 0.01 lsp - debug
time elapsed processing message: 0.000121s
# 0.01 lsp - error
string_of_yojson: string needed

Background: I tried to use ocaml-lsp from autozimu/LanguageClient-neovim but it failed to initialize with the following error:

lsp/src/initialize.ml.SignatureHelpClientCapabilities.signatureInformation_of_yojson:
  the following record elements were undefined: documentationFormat

The problem was caused at the deserialization step.
According to the spec, the property documentationFormat is optional, and the said client actually omits that property. But ocaml-lsp requires that to be given, which is against the spec.

Above is the case I encountered, but I can see many other properties which are optional in the spec but treated as required (e.g. parameterInformation). In my case fixing documentationFormat was enough to get it working, but this may cause similar problems when used from other clients.

I happened upon the following error (again, using nvim and vim-lsp), but I don't know if it is expected:

# 0.00 lsp - debug
recv: {
  "method": "textDocument/didChange",
  "jsonrpc": "2.0",
  "params": {
    "contentChanges": null,
    "textDocument": {
      "uri": "file:///home/guigui/build/dolmen/tests/smtlib/test-002.smt2",
      "version": 2
    }
  }
}
# 0.00 lsp - debug
time elapsed processing message: 0.005331s
# 0.00 lsp - error
list_of_yojson: list needed

The server still runs after the error, but the handler for the notification does not seem to run.

I suppose it might be another instance of the spec moving too fast and it might be fixed by #87 ?

Hi All!
I have been using this lsp frontend quite a bit recently, and had been installing it with opam pin --yes add merlin-lsp.dev https://github.com/ocaml/merlin.git.
Now that it moved here, I've been trying to get opam pin --yes add ocaml-lsp-server.dev https://github.com/ocaml/ocaml-lsp.git to work in the same way, but have been running into several issues.

1. Opam complains about lack of maintainers and synopsis. I was able to silence that by forking and adding them (mrkmndz@891d861)
2. Dune complains about lack of project name. fixed with (mrkmndz@94b18b8)
3. Dune build fails due to "Library "merlin.specific" not found." Adding merlin as a dependency didn't seem to work, and the only thing that seemed to make it build was to switch to dune 2.0.0 (mrkmndz@78ad214). However, this did not feel like the right way to fix it, and causes other problems with my set up.

Furthermore, I can't seem to get it to run once installed in the same way that I used to, namely the form opam exec -- ocaml-lsp-server.

How have you all been running this in development?

empty_server_capabilities, introduced in #40, disappeared in 86aefc0 . Probably a merge gone wrong :)

The most recent version of the specification (3.15) introduced a textDocument/selectionRange request. This request is supposed to suggest available selections to the server.

This very closely corresponds to the Shape command in merlin (cf query_protocol.ml). There is just a bit of a mismatch because merlin returns a tree of shapes (every shape can have many sub shapes), so we'll need to do some intelligent flattening. This last bit we can tweak experimentally after trying out an initial implementation.

This is a commonly required request in the OCaml tooling world. It has been asked several time for dune in the past (ocaml/dune#150) for example, and the conclusion has been reached that it should be done in the editor tooling.

What do you think about it ? Should it be done at the merlin level (ocaml/merlin#538), at the ocaml-lsp level, or at the editor interface level (e.g. vscode-merlin).

In theory, I think it should be as factorised as possible, so not in the editor interface. This could be probably be done with a workspace/executeCommand request ?

This could be done in addition to @rgrinberg's proposition to propose custom completion in mli files

LSIF (Language Server Index Format) - a standard format for language servers or other programming tools to dump their knowledge about a workspace. This dump can later be used to answer language server LSP requests for the same workspace without running the language server itself.

It seems that ocamlformat is needed :

[Error - 15:51:16] Request textDocument/formatting failed.
  Message: Unable to find ocamlformat binary
  Code: -32600 
[Error - 15:51:16] [lsp] Unable to find ocamlformat binary

(VSCode)

This was resolved when I installed it. I think it should be added as a dependency

The way arg parses things is substandard. We should vendor cmdliner and use it instead.

Does it make sense to vendor ocamlformat and all of its dependencies for this?

#113 Has introduced a lot of error responses from the server that seem to be happening on codeAction requests (see note from @rgrinberg in the discussion).

module ZZZ = Base;
ZZZ.<tab>

Nothing is being shown.

Base.<tab> works as expected. Not sure if it's related to vscode extension or ocaml-lsp itself.

It appears the when the client omits the synchronization capabilities (aka the Initialize.Synchronization.t value in a TextDocumentClientCapabilities.t), the default value is to assume that all capabilities are present, see

However, after reading the specification (see quote afterwards), it seems that if omitted, the default capabilities should be assumed to be (at least) the ones present strictly before version 3.x (but not necessarily more I suppose).

Client capabilities got introduced with version 3.0 of the protocol. They therefore only describe capabilities that got introduced in 3.x or later. Capabilities that existed in the 2.x version of the protocol are still mandatory for clients. Clients cannot opt out of providing them. So even if a client omits the ClientCapabilities.textDocument.synchronization it is still required that the client provides text document synchronization (e.g. open, changed and close notifications).

It seems that the willSave, and willSaveWaitUntil capabilities were introduced in 3.0, so I'd guess that the empty, or default, synchronization capabilities should rather be:

let empty = { willSave = false; willSaveWaitUntil = false; didSave = true }

open Angstrom

let f = word >>CURSOR

With cursor on CURSOR, ask for completion. Then select >>| in the answer. The final result is

open Angstrom

let f = word >>>>|

It looks like the prefix is ignored when completing an operator.

JsonRpc is a stand alone & stable protocol. Seems like it would be useful to extract it into its own package.

I want to make a web page that contains an editor of code in OCaml. I prefer to use Monaco Editor. Does anyone know how to connect the Monaco Editor to this ocaml-lsp?

Thank you.

This will give us testing on Mac & Windows.

I want to try ocaml-lsp, however, it gave me an Error: Version 2.0 of dune is not supported.

$ git clone --recurse-submodules http://github.com/ocaml/ocaml-lsp.git
... ...
$ cd ocaml-lsp
$ make build
dune build
File "dune-project", line 1, characters 11-14:
1 | (lang dune 2.0)
               ^^^
Error: Version 2.0 of dune is not supported.
Supported versions:
- 0.0
- 1.0 to 1.11
make: *** [build] Error 1

My dune --version is 1.11.4 and opam --version is 2.0.2. Does anyone know how to fix this?

I've got this error when trying current master (pinned today), along with https://github.com/ocamllabs/vscode-ocaml-platform on a reason project:

Fatal error: exception (Failure "Ast_mapper: OCaml version mismatch or malformed input")
Raised at file "stdlib.ml", line 29, characters 17-33
Called from file "src/driver.ml", line 1290, characters 6-39
Re-raised at file "parsing/location.ml", line 904, characters 14-25
Called from file "src/driver.ml", line 1295, characters 4-59
Called from file ".ppx/4a0d78cf09beeeae6a944eea36bafb81/_ppx.ml", line 1, characters 9-36

My opam switch is currently running 4.06 OCaml compiler, is that version unsupported? I've configured ocaml.lsp.path in vscode settings to point to ocamllsp binary inside my switch.

@avsm I don't think I have the permissions to do this myself.

I remarked that some special characters escape sequences are not replaced in the Uri.to_path function, for instance:

• %2B which maps to +
• %3D which maps to =
• %5E which maps to ^

There is almost certainly other character escape sequences not currently handled (I just happened upon these in my expérimentations), and it might benefit from the automatic translation of #87 ?
In any case, this is not blocking for me, so on this one I can wait for a generic solution, :)

lsp-mode fails if jsonrpc field is missing

https://github.com/emacs-lsp/lsp-mode/blob/44bb6a31a892887f3d05a3333e49d816daf92a2f/lsp-mode.el#L4992

I'm on commit: e5e6ebf9dcf157

I don't know if this is expected but

#=== ERROR while compiling ocaml-lsp-server.~dev ==============================#
# context              2.0.5 | linux/x86_64 | ocaml-base-compiler.4.07.1 | pinned(git+https://github.com/ocaml/ocaml-lsp.git#3e208720)
# path                 ~/zzz/dev/tezos/_opam/.opam-switch/build/ocaml-lsp-server.~dev
# command              ~/.opam/opam-init/hooks/sandbox.sh build dune build -j 3 --root . --ignore-promoted-rules --no-config --profile release ocaml-lsp-server.install
# exit-code            1
# env-file             ~/.opam/log/ocaml-lsp-server-1538-de96f2.env
# output-file          ~/.opam/log/ocaml-lsp-server-1538-de96f2.out
### output ###
# File "vendor/ocaml-syntax-shims/dune-project", line 1, characters 11-14:
# 1 | (lang dune 2.0)
#                ^^^
# Error: Version 2.0 of dune is not supported.
# Supported versions:
# - 0.0
# - 1.0 to 1.11

Here:
https://github.com/ocaml/ocaml-lsp/blob/master/ocaml-lsp-server.opam#L45
the comment says:

# so we do this manually to be compat with dune 1.0 and dune 2.0

Spec says that it can be string but LSP expects only integers
https://www.jsonrpc.org/specification#request_object As consequence I can't use LSP server with QtCreator frontend

Part of the log:

# 0.00 lsp - debug
recv: {
  "id": "{8ae72110-d34a-486d-ae5f-d4ee9ca406b7}",
  "jsonrpc": "2.0",
  "method": "initialize",
  "params": {
    "capabilities": {
      "textDocument": {
        "codeAction": {
          "codeActionLiteralSupport": {
            "codeActionKind": { "valueSet": [ "*" ] }
          }
        },
        "completion": {
          "completionItem": {},
          "completionItemKind": {
            "valueSet": [
              1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
              19, 20, 21, 22, 23, 24, 25
            ]
          },
          "dynamicRegistration": true
        },
        "documentSymbol": {
          "symbolKind": {
            "valueSet": [
              1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18,
              19, 20, 21, 22, 23, 24, 25, 26
            ]
          }
        },
        "synchronization": {
          "didSave": true,
          "dynamicRegistration": true,
          "willSave": true,
          "willSaveWaitUntil": false
        }
      },
      "workspace": { "workspaceFolders": true }
    },
    "processId": 23567,
    "rootUri": null,
    "trace": "off"
  }
}
# 0.00 lsp - debug
time elapsed processing message: 0.000103s
# 0.00 lsp - error
Unexpected packet: Of_yojson_error with exc = Failure("int_of_yojson: integer needed"). 
`String ("{8ae72110-d34a-486d-ae5f-d4ee9ca406b7}")

Merlin in master now marks deprecated items in the completion list appropriately. We should support that.

I was able to build ocaml-lsp find and all of the tests passed. However, the emacs lsp-mode doesn't detect any capabilities, and inspecting the io-log reveals that ocamllsp never responds.

This is the emacs configuration:

(defcustom lsp-ocaml-lsp-server-command
  '("ocamllsp")
  "Command to start ocaml-language-server."
  :group 'lsp-ocaml
  :type '(choice
          (string :tag "Single string value")
          (repeat :tag "List of string values"
                  string)))

(lsp-register-client
 (make-lsp-client
  :new-connection
  (lsp-stdio-connection (lambda () lsp-ocaml-lsp-server-command))
  :major-modes '(caml-mode tuareg-mode)
  :priority 0
  :server-id 'ocaml-lsp-server))

and the io log:

[Trace - 11:58:11 AM] Sending request 'initialize - (3)'.
Params: {
  "processId": 335871,
  "rootPath": "/home/samthomas/Cornell/school/cs3110/spring/RML-2.0",
  "clientInfo": {
    "name": "vscode",
    "version": "1.41.1"
  },
  "rootUri": "file:///home/samthomas/Cornell/school/cs3110/spring/RML-2.0",
  "capabilities": {
    "workspace": {
      "workspaceEdit": {
        "documentChanges": true,
        "resourceOperations": [
          "create",
          "rename",
          "delete"
        ]
      },
      "applyEdit": true,
      "symbol": {
        "symbolKind": {
          "valueSet": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26
          ]
        }
      },
      "executeCommand": {
        "dynamicRegistration": false
      },
      "didChangeWatchedFiles": {
        "dynamicRegistration": true
      },
      "workspaceFolders": true,
      "configuration": true
    },
    "textDocument": {
      "declaration": {
        "linkSupport": true
      },
      "definition": {
        "linkSupport": true
      },
      "implementation": {
        "linkSupport": true
      },
      "typeDefinition": {
        "linkSupport": true
      },
      "synchronization": {
        "willSave": true,
        "didSave": true,
        "willSaveWaitUntil": true
      },
      "documentSymbol": {
        "symbolKind": {
          "valueSet": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            18,
            19,
            20,
            21,
            22,
            23,
            24,
            25,
            26
          ]
        },
        "hierarchicalDocumentSymbolSupport": true
      },
      "formatting": {
        "dynamicRegistration": true
      },
      "rangeFormatting": {
        "dynamicRegistration": true
      },
      "rename": {
        "dynamicRegistration": true,
        "prepareSupport": true
      },
      "semanticHighlightingCapabilities": {
        "semanticHighlighting": false
      },
      "codeAction": {
        "dynamicRegistration": true,
        "isPreferredSupport": true,
        "codeActionLiteralSupport": {
          "codeActionKind": {
            "valueSet": [
              "",
              "quickfix",
              "refactor",
              "refactor.extract",
              "refactor.inline",
              "refactor.rewrite",
              "source",
              "source.organizeImports"
            ]
          }
        }
      },
      "completion": {
        "completionItem": {
          "snippetSupport": true,
          "documentationFormat": [
            "markdown"
          ]
        },
        "contextSupport": true
      },
      "signatureHelp": {
        "signatureInformation": {
          "parameterInformation": {
            "labelOffsetSupport": true
          }
        }
      },
      "documentLink": {
        "dynamicRegistration": true,
        "tooltipSupport": true
      },
      "hover": {
        "contentFormat": [
          "markdown",
          "plaintext"
        ]
      },
      "foldingRange": {
        "dynamicRegistration": true,
        "rangeLimit": null,
        "lineFoldingOnly": false
      },
      "callHierarchy": {
        "dynamicRegistration": false
      }
    },
    "window": {
      "workDoneProgress": true
    }
  },
  "initializationOptions": null,
  "workDoneToken": "1"
}

ocaml-lsp's memory use grows when I modify a file that it's watching. I've seen it use up to 20Gb of memory. After bisecting, it seems that the bug was introduced by 8a27349. Unfortunately, it's a huge commit so I don't see an obvious culprit.

This is on macos 10.15.3, ocaml 4.08.1.

Some code styles are a bit broken, so setting the OCamlFormat doesn't sound bad.