cameel / yul-lsp Goto Github PK

Add support for the Highlights Request request.

It is partially implemented using Dune API but the LSP was crashing when I tried to use that with QtCreator on the hackathon. See dune-request-on-hover branch.

My suggestion would be to not use Dune for this at all and switch to https://www.4byte.directory instead, which also seems to be pretty relaxed about access to the data:

The data from this service is given free of any license or restrictions on how it may be used.

Usage of the API is also granted with the single restriction that your usage should not disrupt the service itself. If you wish to scrape this data, feel free, but please do so with limited concurrency. You are encouraged to scrape your own copy of this data if your use case is likely to produce heavy load on the API.

The feature should be properly covered by tests and documented.

Add any necessary configuration for easy integration with Vim and document it.

I'd suggest starting with neovim since it has a built-in LSP and should be the easiest.

Add support for the Signature Help request.

We need a way to test the LSP in CI. I think we should implement a simple client and use it to write some end-to-end tests.

Check what other LSP implementation are doing. Maybe there's a ready to use crate for that.

Add support for the Rename request.

The feature was implemented in a rush at the hackathon and needs cleanup and improvements:

• We seem to have a duplicate of tower_lsp::lsp_types::TextDocumentItem struct in our code (that also causes warnings due to unused fields). We should switch to using that directly.
• We have no tests covering it.
• We only managed to work with an old version of QtCreator. We need to make it work in all editors.

Create a simple extension to make the server usable with VSCode. Unfortunately VSCode seems to require implementing your own LSP client as an extension. See Language Server Extension Guide.

The task includes publishing the extension and documenting how to use it.

We had a chat with @bunsenstraat (of Remix) about their LSP feature, which already works for Solidity. It uses a mix of AST JSON and a custom parser.

I was wondering if we could provide a simple non-HTTP LSP API of this library, compiled to wasm, to be used by Remix for Yul LSP. Once that works, we could provide Solidity LSP via the very same interface, and potentially as a separate project not integrated into the main solc codebase.

Add support for PublishDiagnostics message. The server should store any errors detected while parsing and let the client access and display them.

Later we may want to also add errors detected at the resolution stage. This will require adding proper support for that in yultsur - currently it just panics.