281 lines
13 KiB
Lua
281 lines
13 KiB
Lua
return {
|
|
-- LSP Plugins
|
|
{
|
|
-- `lazydev` configures Lua LSP for your Neovim config, runtime and plugins
|
|
-- used for completion, annotations and signatures of Neovim apis
|
|
'folke/lazydev.nvim',
|
|
ft = 'lua',
|
|
opts = {
|
|
library = {
|
|
-- Load luvit types when the `vim.uv` word is found
|
|
{ path = '${3rd}/luv/library', words = { 'vim%.uv' } },
|
|
},
|
|
},
|
|
},
|
|
{
|
|
-- LSP Configuration & Plugins
|
|
'neovim/nvim-lspconfig',
|
|
dependencies = {
|
|
-- Automatically install LSPs and related tools to stdpath for Neovim
|
|
{ 'mason-org/mason.nvim', config = true }, -- NOTE: Must be loaded before dependants
|
|
'mason-org/mason-lspconfig.nvim',
|
|
'WhoIsSethDaniel/mason-tool-installer.nvim',
|
|
|
|
-- Useful status updates for LSP.
|
|
-- NOTE: `opts = {}` is the same as calling `require('fidget').setup({})`
|
|
{ 'j-hui/fidget.nvim', opts = {} },
|
|
--
|
|
-- Allows extra capabilities provided by blink.cmp
|
|
'saghen/blink.cmp',
|
|
},
|
|
config = function()
|
|
-- some default parameters
|
|
vim.lsp.inlay_hint.enable(true, nil)
|
|
|
|
-- Brief aside: **What is LSP?**
|
|
--
|
|
-- LSP is an initialism you've probably heard, but might not understand what it is.
|
|
--
|
|
-- LSP stands for Language Server Protocol. It's a protocol that helps editors
|
|
-- and language tooling communicate in a standardized fashion.
|
|
--
|
|
-- In general, you have a "server" which is some tool built to understand a particular
|
|
-- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers
|
|
-- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone
|
|
-- processes that communicate with some "client" - in this case, Neovim!
|
|
--
|
|
-- LSP provides Neovim with features like:
|
|
-- - Go to definition
|
|
-- - Find references
|
|
-- - Autocompletion
|
|
-- - Symbol Search
|
|
-- - and more!
|
|
--
|
|
-- Thus, Language Servers are external tools that must be installed separately from
|
|
-- Neovim. This is where `mason` and related plugins come into play.
|
|
--
|
|
-- If you're wondering about lsp vs treesitter, you can check out the wonderfully
|
|
-- and elegantly composed help section, `:help lsp-vs-treesitter`
|
|
|
|
-- This function gets run when an LSP attaches to a particular buffer.
|
|
-- That is to say, every time a new file is opened that is associated with
|
|
-- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this
|
|
-- function will be executed to configure the current buffer
|
|
|
|
vim.api.nvim_create_autocmd('LspAttach', {
|
|
group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }),
|
|
callback = function(event)
|
|
-- NOTE: Remember that Lua is a real programming language, and as such it is possible
|
|
-- to define small helper and utility functions so you don't have to repeat yourself.
|
|
--
|
|
-- In this case, we create a function that lets us more easily define mappings specific
|
|
-- for LSP related items. It sets the mode, buffer and description for us each time.
|
|
local map = function(keys, func, desc)
|
|
vim.keymap.set('n', keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc })
|
|
end
|
|
|
|
-- Jump to the definition of the word under your cursor.
|
|
-- This is where a variable was first declared, or where a function is defined, etc.
|
|
-- To jump back, press <C-t>.
|
|
map('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
|
|
|
|
-- Find references for the word under your cursor.
|
|
map('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
|
|
|
|
-- Jump to the implementation of the word under your cursor.
|
|
-- Useful when your language has ways of declaring types without an actual implementation.
|
|
map('gI', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')
|
|
|
|
-- Jump to the type of the word under your cursor.
|
|
-- Useful when you're not sure what type a variable is and you want to see
|
|
-- the definition of its *type*, not where it was *defined*.
|
|
map('<leader>D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')
|
|
|
|
-- Fuzzy find all the symbols in your current document.
|
|
-- Symbols are things like variables, functions, types, etc.
|
|
map('<leader>ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')
|
|
|
|
-- Fuzzy find all the symbols in your current workspace.
|
|
-- Similar to document symbols, except searches over your entire project.
|
|
map('<leader>ws', require('telescope.builtin').lsp_dynamic_workspace_symbols, '[W]orkspace [S]ymbols')
|
|
|
|
-- Rename the variable under your cursor.
|
|
-- Most Language Servers support renaming across files, etc.
|
|
map('<leader>rn', vim.lsp.buf.rename, '[R]e[n]ame')
|
|
|
|
-- Execute a code action, usually your cursor needs to be on top of an error
|
|
-- or a suggestion from your LSP for this to activate.
|
|
map('<leader>ca', vim.lsp.buf.code_action, '[C]ode [A]ction')
|
|
|
|
-- Opens a popup that displays documentation about the word under your cursor
|
|
-- See `:help K` for why this keymap.
|
|
map('K', vim.lsp.buf.hover, 'Hover Documentation')
|
|
|
|
-- WARN: This is not Goto Definition, this is Goto Declaration.
|
|
-- For example, in C this would take you to the header.
|
|
map('gD', vim.lsp.buf.declaration, '[G]oto [D]eclaration')
|
|
|
|
-- The following two autocommands are used to highlight references of the
|
|
-- word under your cursor when your cursor rests there for a little while.
|
|
-- See `:help CursorHold` for information about when this is executed
|
|
--
|
|
-- When you move your cursor, the highlights will be cleared (the second autocommand).
|
|
---- This function resolves a difference between neovim nightly (version 0.11) and stable (version 0.10)
|
|
---@param client vim.lsp.Client
|
|
---@param method vim.lsp.protocol.Method
|
|
---@param bufnr? integer some lsp support methods only in specific files
|
|
---@return boolean
|
|
local function client_supports_method(client, method, bufnr)
|
|
if vim.fn.has 'nvim-0.11' == 1 then
|
|
return client:supports_method(method, bufnr)
|
|
else
|
|
return client.supports_method(method, { bufnr = bufnr })
|
|
end
|
|
end
|
|
|
|
local client = vim.lsp.get_client_by_id(event.data.client_id)
|
|
if client and client_supports_method(client, vim.lsp.protocol.Methods.textDocument_documentHighlight, event.buf) then
|
|
local highlight_augroup = vim.api.nvim_create_augroup('kickstart-lsp-highlight', { clear = false })
|
|
vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, {
|
|
buffer = event.buf,
|
|
group = highlight_augroup,
|
|
callback = vim.lsp.buf.document_highlight,
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, {
|
|
buffer = event.buf,
|
|
group = highlight_augroup,
|
|
callback = vim.lsp.buf.clear_references,
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd('LspDetach', {
|
|
group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }),
|
|
callback = function(event2)
|
|
vim.lsp.buf.clear_references()
|
|
vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf }
|
|
end,
|
|
})
|
|
end
|
|
|
|
-- The following autocommand is used to enable inlay hints in your
|
|
-- code, if the language server you are using supports them
|
|
--
|
|
-- This may be unwanted, since they displace some of your code
|
|
vim.lsp.inlay_hint.enable(true)
|
|
if client and client_supports_method(client, vim.lsp.protocol.Methods.textDocument_inlayHint, event.buf) then
|
|
map('<leader>th', function()
|
|
vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled { bufnr = event.buf })
|
|
end, '[T]oggle Inlay [H]ints')
|
|
end
|
|
|
|
if client and client_supports_method(client, 'textDocument/foldingRange', event.buf) then
|
|
-- local win = vim.api.nvim_get_current_win()
|
|
-- vim.wo[win][0].foldexpr = 'v:lua.vim.lsp.foldexpr()'
|
|
end
|
|
end,
|
|
})
|
|
|
|
-- Diagnostic Config
|
|
-- See :help vim.diagnostic.Opts
|
|
vim.diagnostic.config {
|
|
severity_sort = true,
|
|
float = { border = 'rounded', source = 'if_many' },
|
|
underline = { severity = vim.diagnostic.severity.ERROR },
|
|
signs = vim.g.have_nerd_font
|
|
and {
|
|
text = {
|
|
[vim.diagnostic.severity.ERROR] = ' ', -- circle with cross
|
|
[vim.diagnostic.severity.WARN] = ' ', -- triangle warning
|
|
[vim.diagnostic.severity.INFO] = ' ', -- circle with i
|
|
[vim.diagnostic.severity.HINT] = ' ', -- lightbulb
|
|
},
|
|
}
|
|
or {},
|
|
virtual_text = {
|
|
source = 'if_many',
|
|
spacing = 2,
|
|
format = function(diagnostic)
|
|
local diagnostic_message = {
|
|
[vim.diagnostic.severity.ERROR] = diagnostic.message,
|
|
[vim.diagnostic.severity.WARN] = diagnostic.message,
|
|
[vim.diagnostic.severity.INFO] = diagnostic.message,
|
|
[vim.diagnostic.severity.HINT] = diagnostic.message,
|
|
}
|
|
return diagnostic_message[diagnostic.severity]
|
|
end,
|
|
},
|
|
}
|
|
|
|
-- LSP servers and clients are able to communicate to each other what features they support.
|
|
-- By default, Neovim doesn't support everything that is in the LSP specification.
|
|
-- When you add blink.cmp, luasnip, etc. Neovim now has *more* capabilities.
|
|
-- So, we create new capabilities with blink.cmp, and then broadcast that to the servers.
|
|
-- local capabilities = require('blink.cmp').get_lsp_capabilities()
|
|
-- LSP servers and clients are able to communicate to each other what features they support.
|
|
-- By default, Neovim doesn't support everything that is in the LSP specification.
|
|
-- When you add nvim-cmp, luasnip, etc. Neovim now has *more* capabilities.
|
|
-- So, we create new capabilities with nvim cmp, and then broadcast that to the servers.
|
|
local capabilities = vim.lsp.protocol.make_client_capabilities()
|
|
capabilities = vim.tbl_deep_extend('force', capabilities, require('cmp_nvim_lsp').default_capabilities())
|
|
|
|
-- Ensure the servers and tools above are installed
|
|
-- To check the current status of installed tools and/or manually install
|
|
-- other tools, you can run
|
|
-- :Mason
|
|
--
|
|
-- You can press `g?` for help in this menu.
|
|
-- require('mason').setup()
|
|
|
|
-- You can add other tools here that you want Mason to install
|
|
-- for you, so that they are available from within Neovim.
|
|
-- require('mason-tool-installer').setup { ensure_installed = ensure_installed }
|
|
|
|
-- INFO: Using my own utils function instead of mason-lspconfig as it checks if the stuff is already installed
|
|
-- outside of mason. This is useful for NixOS setup where mason version just doesn't work sometimes due to libc issues.
|
|
-- We take the languages configured for a given profile
|
|
-- Given the profile we take the LSPs configured for the languages
|
|
-- Then we guarantee use or install the LSPs
|
|
local lsps = require('utils.profile').LanguageServers()
|
|
-- print(vim.inspect(lsps))
|
|
local missing_lsps = require('utils.mason').missing(lsps) -- find missing lsps
|
|
-- print(vim.inspect(missing_lsps))
|
|
missing_lsps = {} -- TODO: this is only for NixOS to prefer installing via nixpkgs instead of mason
|
|
|
|
-- install the executables of the language servers that we don't already have installed locally outside of mason
|
|
require('utils.mason').install(missing_lsps)
|
|
|
|
-- configure nvim lsp via lspconfig package for our list of lsps
|
|
-- local lspconfig = require 'lspconfig'
|
|
for server, config in pairs(lsps) do
|
|
-- tbl_deep_extend with force -> on conflict use value from right
|
|
config.capabilities = vim.tbl_deep_extend('force', {}, capabilities, config.capabilities or {})
|
|
|
|
-- the require(lspconfig)[server].setup({...}) notation is deprecated in nvim-lspconfig
|
|
-- Thus we use the new notation for setting up LSPs
|
|
-- Part below is equivalent to require('lspconfig')[server].setup(config)
|
|
vim.lsp.config(server, config)
|
|
vim.lsp.enable(server)
|
|
end
|
|
end,
|
|
},
|
|
-- Show LSP explorer of functions and classes etc.
|
|
{
|
|
'hedyhli/outline.nvim',
|
|
lazy = true,
|
|
cmd = { 'Outline', 'OutlineOpen' },
|
|
keys = { -- Example mapping to toggle outline
|
|
{ '<leader>o', '<cmd>Outline<CR>', desc = 'Toggle outline' },
|
|
},
|
|
opts = {},
|
|
},
|
|
|
|
-- Shows where you are in the file LSP wise (which class/function etc)
|
|
{
|
|
'ray-x/lsp_signature.nvim',
|
|
event = 'VeryLazy',
|
|
config = function(_, opts)
|
|
require('lsp_signature').setup(opts)
|
|
end,
|
|
},
|
|
}
|