ItalianSwirls/README.md

61 lines
2 KiB
Markdown
Raw Normal View History

2022-12-01 16:48:31 +01:00
Italian Swirls 🍝
=================
Minimal Python language server, based on [Jedi][jedi] and [pygls][pygls].
[jedi]: https://jedi.readthedocs.io/en/latest/index.html
[pygls]: https://pygls.readthedocs.io/en/latest/index.html
Still in development but works on my machine. ✨
2022-12-03 16:39:56 +01:00
Supported features:
| LSP method | Description |
|-------------------------------|----------------------------|
| `textDocument/completion` | Complete |
| `textDocument/definition` | Go to definition |
| `textDocument/typeDefinition` | Go to type definition |
| `textDocument/hover` | Show documentation |
| `textDocument/references` | Show references |
| `textDocument/rename` | Renaming symbols and files |
2022-12-03 16:39:56 +01:00
Install
-------
TODO
2022-12-01 16:48:31 +01:00
About
-----
### Why?
General-purpose servers (e.g. pyls, py-lsp) try to do too much and break stuff
too often for me. Locking Neovim when I press tab, crashes of all kind,
LspRestart failing. Also I like my linting and formatting done by dedicated
tools such as [nvim-lint][nvim-lint] and [formatter][formatter].
2022-12-01 16:48:31 +01:00
[nvim-lint]: https://github.com/mfussenegger/nvim-lint
[formatter]: https://github.com/mhartington/formatter.nvim
Other Jedi-based servers (e.g. jedi-language-server) seem to focus on coc-nvim
and frequently fail on Neovim's native LSP client for me. I tried to fix
jedi-language-server several times when it failed me but I thought it could be
fun to try pygls to redo it as small and simple as I can. And running a Node
server to get Python completions? No way. That said, jedi-language-server is a
good project and if you're fine with coc-nvim you should definitely check it
out. Lots of the code here is ~~stolen~~ inspired from this project.
2022-12-01 16:48:31 +01:00
### Why the name?
Take the string “Is this a Star Wars reference?” Language Server, compress it to
`ITASWRLS` and expand it back to Italian Swirls. Italian dishes are made of few
elements that work well together. Enough questions!
2022-12-03 16:40:05 +01:00
### License
GPLv3.