Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vonheikemen/lsp-zero.nvim
A starting point to setup some lsp related features in neovim.
https://github.com/vonheikemen/lsp-zero.nvim
language-server-protocol lsp neovim nvim
Last synced: 1 day ago
JSON representation
A starting point to setup some lsp related features in neovim.
- Host: GitHub
- URL: https://github.com/vonheikemen/lsp-zero.nvim
- Owner: VonHeikemen
- License: mit
- Created: 2022-02-20T02:19:37.000Z (over 2 years ago)
- Default Branch: v4.x
- Last Pushed: 2024-11-12T00:39:27.000Z (9 days ago)
- Last Synced: 2024-11-19T09:06:50.842Z (1 day ago)
- Topics: language-server-protocol, lsp, neovim, nvim
- Language: Lua
- Homepage: https://lsp-zero.netlify.app/docs/
- Size: 978 KB
- Stars: 3,862
- Watchers: 12
- Forks: 100
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LSP Zero
Collection of [functions](https://lsp-zero.netlify.app/docs/reference/lua-api.html) and a [documentation site](https://lsp-zero.netlify.app/docs/getting-started.html) that will help you use Neovim's LSP client.
> [!IMPORTANT]
> `v4.x` became the default branch on `August 2024`. If you are here because of a youtube video or some other tutorial, there is a good chance the configuration they show is outdated. The [quickstart section](#quickstart-for-the-impatient) has a example config.
## Demo
In the past most people used lsp-zero to help them setup [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) and [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig). This use case doesn't require you to have lsp-zero installed anymore. The steps to make this work are covered in the [getting started](https://lsp-zero.netlify.app/docs/getting-started.html) page.
> See [demo in asciinema](https://asciinema.org/a/636643)
[](https://asciinema.org/a/636643)
## Documentation
You can browse the documentation here: [lsp-zero.netlify.app/docs](https://lsp-zero.netlify.app/docs/introduction.html)
* [Tutorial for beginners](https://lsp-zero.netlify.app/docs/tutorial.html)
* [Installation and Basic Usage](https://lsp-zero.netlify.app/docs/getting-started.html)
* [LSP Configuration](https://lsp-zero.netlify.app/docs/language-server-configuration.html)
* [Autocomplete](https://lsp-zero.netlify.app/docs/autocomplete.html)
### Upgrade guides
* [from v3.x to v4.x](https://lsp-zero.netlify.app/docs/guide/migrate-from-v3-branch.html)
* [from v2.x to v4.x](https://lsp-zero.netlify.app/docs/guide/migrate-from-v2-branch.html)
* [from v1.x to v4.x](https://lsp-zero.netlify.app/docs/guide/migrate-from-v1-branch.html)
## Quickstart (for the impatient)
For detailed instructions visit the [getting started](https://lsp-zero.netlify.app/docs/getting-started.html) page or the [tutorial for beginners](https://lsp-zero.netlify.app/docs/tutorial.html).
Make sure you have all these plugins installed.
* [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
* [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
* [hrsh7th/cmp-nvim-lsp](https://github.com/hrsh7th/cmp-nvim-lsp)
The following piece of code should be enough to get a basic setup:
```lua
-- NOTE: to make any of this work you need a language server.
-- If you don't know what that is, watch this 5 min video:
-- https://www.youtube.com/watch?v=LaS32vctfOY
-- Reserve a space in the gutter
vim.opt.signcolumn = 'yes'
-- Add cmp_nvim_lsp capabilities settings to lspconfig
-- This should be executed before you configure any language server
local lspconfig_defaults = require('lspconfig').util.default_config
lspconfig_defaults.capabilities = vim.tbl_deep_extend(
'force',
lspconfig_defaults.capabilities,
require('cmp_nvim_lsp').default_capabilities()
)
-- This is where you enable features that only work
-- if there is a language server active in the file
vim.api.nvim_create_autocmd('LspAttach', {
desc = 'LSP actions',
callback = function(event)
local opts = {buffer = event.buf}
vim.keymap.set('n', 'K', 'lua vim.lsp.buf.hover()', opts)
vim.keymap.set('n', 'gd', 'lua vim.lsp.buf.definition()', opts)
vim.keymap.set('n', 'gD', 'lua vim.lsp.buf.declaration()', opts)
vim.keymap.set('n', 'gi', 'lua vim.lsp.buf.implementation()', opts)
vim.keymap.set('n', 'go', 'lua vim.lsp.buf.type_definition()', opts)
vim.keymap.set('n', 'gr', 'lua vim.lsp.buf.references()', opts)
vim.keymap.set('n', 'gs', 'lua vim.lsp.buf.signature_help()', opts)
vim.keymap.set('n', '', 'lua vim.lsp.buf.rename()', opts)
vim.keymap.set({'n', 'x'}, '', 'lua vim.lsp.buf.format({async = true})', opts)
vim.keymap.set('n', '', 'lua vim.lsp.buf.code_action()', opts)
end,
})
-- You'll find a list of language servers here:
-- https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md
-- These are example language servers.
require('lspconfig').gleam.setup({})
require('lspconfig').ocamllsp.setup({})
local cmp = require('cmp')
cmp.setup({
sources = {
{name = 'nvim_lsp'},
},
snippet = {
expand = function(args)
-- You need Neovim v0.10 to use vim.snippet
vim.snippet.expand(args.body)
end,
},
mapping = cmp.mapping.preset.insert({}),
})
```
### Why is lsp-zero not used there?
Because lsp-zero is not the plugin it used to be back in 2022. And its clear to me now that adding even a tiny layer of abstraction on top of this setup can cause a huge amount of confusion. If you want to know what lsp-zero can do, you can check the functions it has available in the [Lua API](https://lsp-zero.netlify.app/docs/reference/lua-api.html).
For better or worse the documentation is the most valuable thing of lsp-zero. The docs will teach you how to use all the moving pieces of a typical "LSP setup" in Neovim.
## Support
If you find this useful and want to support my efforts, consider leave a tip in [ko-fi.com ☕](https://ko-fi.com/vonheikemen).
[](https://ko-fi.com/vonheikemen)