Files

257 lines
9.4 KiB
Lua

-- ============================================================
-- SECTION 5: LSP
-- LSP keymaps, server configuration, Mason tools installations
-- ============================================================
do
-- [[ LSP Configuration ]]
-- 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`
-- Useful status updates for LSP.
vim.pack.add { gh 'j-hui/fidget.nvim' }
safe_require 'fidget'
-- 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, mode)
mode = mode or 'n'
vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc })
end
-- Rename the variable under your cursor.
-- Most Language Servers support renaming across files, etc.
map('<leader>lr', vim.lsp.buf.rename, '[R]e[n]ame')
map('<leader>ld', vim.lsp.buf.definition, '[L]sp goto [D]definition')
map('<leader>la', vim.lsp.buf.code_action, '[L]sp goto Code [A]ction', { 'n', 'x' })
-- Apply all automatic code fixes in the current buffer
map('<leader>lA', function()
vim.lsp.buf.code_action {
context = {
only = { 'source.fixAll' },
diagnostics = {},
},
apply = true,
}
end, '[L]sp Fix [A]ll in buffer')
map('<leader>lD', vim.lsp.buf.declaration, '[L]sp goto [D]eclaration')
map('es', vim.diagnostic.open_float, '[E]rror message [S]how')
map('ej', function() vim.diagnostic.jump { count = 1 } end, '[E]rror next')
map('ek', function() vim.diagnostic.jump { count = -1 } end, '[E]rror previous')
-- 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).
local client = vim.lsp.get_client_by_id(event.data.client_id)
if client and client:supports_method('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 code creates a keymap to toggle 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
if client and client:supports_method('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
end,
})
-- Enable the following language servers
-- Feel free to add/remove any LSPs that you want here. They will automatically be installed.
-- See `:help lsp-config` for information about keys and how to configure
local formatters_and_tools = {
'shfmt',
'stylua',
}
if vim.g.load_devops then vim.list_extend(formatters_and_tools, { 'nixfmt', 'terraform', 'yamlfmt' }) end
if vim.g.load_development then vim.list_extend(formatters_and_tools, { 'black', 'isort', 'clang-format', 'ktfmt' }) end
-- Servers that apply regardless of profile
---@type table<string, vim.lsp.Config>
local servers = {
-- json
jsonls = {},
-- bash / sh
bashls = {},
-- markdown / prose
markdown_oxide = {},
-- Special Lua Config, as recommended by neovim help docs
lua_ls = {
on_init = function(client)
client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua)
if client.workspace_folders then
local path = client.workspace_folders[1].name
if path ~= vim.fn.stdpath 'config' and (vim.uv.fs_stat(path .. '/.luarc.json') or vim.uv.fs_stat(path .. '/.luarc.jsonc')) then return end
end
client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, {
runtime = {
version = 'LuaJIT',
path = { 'lua/?.lua', 'lua/?/init.lua' },
},
workspace = {
checkThirdParty = false,
-- NOTE: this is a lot slower and will cause issues when working on your own configuration.
-- See https://github.com/neovim/nvim-lspconfig/issues/3189
library = vim.tbl_extend('force', vim.api.nvim_get_runtime_file('', true), {
'${3rd}/luv/library',
'${3rd}/busted/library',
}),
},
})
end,
---@type lspconfig.settings.lua_ls
settings = {
Lua = {
format = { enable = false }, -- Disable formatting (formatting is done by stylua)
},
},
},
}
-- Infrastructure / DevOps profile
if vim.g.load_devops then
-- terraform
servers.terraformls = {}
-- nix
servers.nil_ls = {}
-- yaml
servers.yamlls = {
settings = {
yaml = {
schemaStore = { enable = true },
validate = true,
format = { enable = false }, -- formatting is handled by conform
},
},
}
end
-- General development profile
if vim.g.load_development then
servers.clangd = {
cmd = { 'clangd', '--background-index', '--clang-tidy' },
}
servers.neocmake = {}
servers.pyright = {}
servers.ruff = {}
servers.kotlin_lsp = {}
servers.texlab = {}
servers.kakehashi = {
filetypes = { 'markdown' },
init_options = {
languageServers = {
['texlab'] = {
cmd = { 'texlab' },
languages = { 'latex' },
},
['lua_ls'] = {
cmd = { 'lua-language-server' },
languages = { 'lua' },
},
},
languages = {
_ = {
autoInstall = true,
},
markdown = {
bridge = {
texlab = { enabled = true },
lua_ls = { enabled = true },
},
},
},
},
}
end
vim.pack.add {
gh 'neovim/nvim-lspconfig',
gh 'mason-org/mason.nvim',
gh 'mason-org/mason-lspconfig.nvim',
gh 'WhoIsSethDaniel/mason-tool-installer.nvim',
}
-- Automatically install LSPs and related tools to stdpath for Neovim
safe_require 'mason'
-- 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.
local ensure_installed = vim.tbl_keys(servers or {})
vim.list_extend(ensure_installed, formatters_and_tools)
safe_require('mason-tool-installer', { ensure_installed = ensure_installed, auto_update = false, run_on_start = true }, function(_)
-- for name in ensure_installed do
-- vim.lsp.enable(name)
-- end
for name, server in pairs(servers) do
vim.lsp.config(name, server)
vim.lsp.enable(name)
end
end)
end