Gerbil LSP server #781

New issue

2023-09-04T09:01:03Z

vyzo commented

2023-09-04 09:01:03 +00:00

(Migrated from github.com)

We want to implement a Gerbil server speaking the LSP protocol; this will bring first class Gerbil support to editors other than emacs, but also improve emacs integration as modern emacs has pretty good support for it.

There is funding available for this project.

We want to implement a Gerbil server speaking the LSP protocol; this will bring first class Gerbil support to editors other than emacs, but also improve emacs integration as modern emacs has pretty good support for it. There is funding available for this project.

chiefnoah commented

2024-03-24 23:19:23 +00:00

(Migrated from github.com)

Some notes on work for the

MVP LSP features:

Goto
Autocomplete
Find references
Hover / Documentation

This is a non-exhaustive list of features. The requisite requests are broken out below
and linked back to the spec. There may be some implicit dependencies that are missed, so
refer to prior art and the LSP documentation for authoritative information.

Goto

This feature is basically the same functionality as covered by TAGS.

There are 4 different types of navigational gotos:

The LSP must declare the linkSupport capability
(textDocument.declaration.linkSupport).

We can likely get away with simple a "go to symbol definition" for now, which should be
implemented using the Goto definition request.

Autocomplete

textDocument/completion

The client will send a completion request
with the LSP responding with appropriate suggestions.

It does not appear to be necessary, but implementing Completion Item Resolve Requst
is likely a good idea as well.

Find References

Find references is simple and is implemented with the Find Reference
Request

Hover documentation

This is typically used to show documentation and signatures. The output is arbitrary "helpful" text. MVP is to show the signature, but with the @doc macro, documentation should be resolved and returned as well.

One thing to note, I believe #815 is a requirement for getting this working, I'm not sure where that stands.

Some notes on work for the MVP LSP features: - Goto - Autocomplete - Find references - Hover / Documentation This is a non-exhaustive list of features. The requisite requests are broken out below and linked back to the spec. There may be some implicit dependencies that are missed, so refer to prior art and the LSP documentation for authoritative information. ## Goto This feature is basically the same functionality as covered by TAGS. There are 4 different types of navigational gotos: - [Goto declaration](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_declaration) - [Goto definition](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_definition) - [Goto type definition](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_typeDefinitionl) - [Goto implementation](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_implementation) The LSP must declare the linkSupport capability (`textDocument.declaration.linkSupport`). We can likely get away with simple a "go to symbol definition" for now, which should be implemented using the Goto definition request. ## Autocomplete [`textDocument/completion`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_completion) The client will send a [completion request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_completion) with the LSP responding with appropriate suggestions. It does not appear to be necessary, but implementing [Completion Item Resolve Requst](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#completionItem_resolve) is likely a good idea as well. ## Find References Find references is simple and is implemented with the [Find Reference Request](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_references) ## Hover documentation This is typically used to show documentation and signatures. The output is arbitrary "helpful" text. MVP is to show the signature, but with the `@doc` macro, documentation should be resolved and returned as well. One thing to note, I believe #815 is a requirement for getting this working, I'm not sure where that stands.

metaleap commented

2024-06-16 15:03:27 +00:00

(Migrated from github.com)

Currently iterating on the LSP as (temporarily) a standalone program, continued from @belmarca's gxlsp.ss, to then be brought back in to the lsp branch after a couple real actual feature impl's.

Since src/tools has plenty other programs, the bulk of this will probably go in std/ide/lsp as #1226 hinted at. Because I imagine building code under std/ might be somewhat slow, I went for the above standalone program for now to iterate on functionality and scaffold / stub things out near-fully.

Currently iterating on the LSP as (temporarily) a [standalone](https://github.com/metaleap/gerbil-lsp) program, continued from @belmarca's [gxlsp.ss](https://github.com/mighty-gerbils/gerbil/blob/f1ee60b3ce15110d488e022052395116f528166c/src/tools/gxlsp.ss), to then be brought back in to the `lsp` branch after a couple real actual feature impl's. Since `src/tools` has plenty other programs, the bulk of this will probably go in `std/ide/lsp` as #1226 hinted at. Because I imagine building code under `std/` might be somewhat slow, I went for the above standalone program for now to iterate on functionality and scaffold / stub things out near-fully.

Sign in to join this conversation.