[feature] lsp documentation

[chrisgrieser]

Currently, the documentation on how to use ast-grep as LSP is rather sparse. I got it working in nvim, via vim.lsp.start, but commonly, LSPs have settings, initialization options, code actions (fixing stuff), etc. – even if there isn't a lot (yet), knowing that there is not much to configure would be useful.

⭐ Suggestion

1. Add some documentation on the LSP to the docs.
2. Add some documentation to sg lsp --help

💻 Use Cases

I create a PR to make it easier to add in the LSP in nvim: neovim/nvim-lspconfig#2880
It works basically, but having being able to potentially configure more stuff could be useful

[HerringtonDarkholme]

Wow! Thanks for your question and contribution to nvim-lspconfig!

LSP now is somewhat crude and does not have configurations.

Appreciate your suggestion on what configuration option can be.
I will investigate them and document them soon~

[HerringtonDarkholme]

ast-grep LSP's capability

• https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics
• https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction
• custom command search https://github.com/ast-grep/ast-grep/blob/main/crates/cli/src/lsp.rs#L14

Client capability:

• textDocument/didOpen
• textDocument/didChange
• textDocument/didClose

Configuration:
No option is supported yet, except that ast-grep LSP requires sgconfig.yml in the project root.

[0xdevalias]

I noticed this issue was closed by this commit:

• ast-grep/ast-grep.github.io@4270de9

But was wondering, should the textDocument/didOpen, textDocument/didChange, textDocument/didClose dotpoints in those docs link to something as they did above in #697 (comment) ?

Client capability:

• textDocument/didOpen
• textDocument/didChange
• textDocument/didClose

[HerringtonDarkholme]

added @0xdevalias

[0xdevalias]

added

@HerringtonDarkholme Not sure if you misread what I said above, or it hasn't been pushed, but that doesn't seem to be the case?

• https://github.com/ast-grep/ast-grep.github.io/commits/4270de992f3e6197724bb95de4242a0f10f8b069/website/guide/tools/editors.md

Still points to this commit as the latest, which doesn't have the links I was asking about:

• ast-grep/ast-grep.github.io@4270de9

Specifically:

should the textDocument/didOpen, textDocument/didChange, textDocument/didClose dotpoints in those docs link to something

[HerringtonDarkholme]

ast-grep/ast-grep.github.io@45dd4b1

[0xdevalias]

@HerringtonDarkholme Awesome, thankyou! :)