mirror of
https://github.com/NotAShelf/neovim-flake.git
synced 2024-12-25 05:39:48 +01:00
lsp: make key bindings configurable
This exposes the keybindings for the lsp commands to the configuration and maps a few more commands (e.g. `vim.lsp.buf.format()`) It also adds a description to be picked up by whichkey to make the whichkey UX a bit nicer (ie. we're now showing "Go to definition" instead of just "vim.lsp.buf.definition()")
This commit is contained in:
parent
29de5b56c0
commit
c693d2fbd4
3 changed files with 90 additions and 23 deletions
|
@ -79,3 +79,5 @@ https://github.com/ksonj[ksonj]:
|
||||||
* Add black-and-isort python formatter
|
* Add black-and-isort python formatter
|
||||||
|
|
||||||
* Removed redundant "Enable ..." in `mkEnableOption` descriptions
|
* Removed redundant "Enable ..." in `mkEnableOption` descriptions
|
||||||
|
|
||||||
|
* Add options to modify LSP key bindings and add proper whichkey descriptions
|
||||||
|
|
|
@ -8,31 +8,41 @@ with lib;
|
||||||
with builtins; let
|
with builtins; let
|
||||||
cfg = config.vim.lsp;
|
cfg = config.vim.lsp;
|
||||||
usingNvimCmp = config.vim.autocomplete.enable && config.vim.autocomplete.type == "nvim-cmp";
|
usingNvimCmp = config.vim.autocomplete.enable && config.vim.autocomplete.type == "nvim-cmp";
|
||||||
|
self = import ./module.nix {inherit config lib pkgs;};
|
||||||
|
|
||||||
|
mappingDefinitions = self.options.vim.lsp.mappings;
|
||||||
|
mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions;
|
||||||
|
mkBinding = binding: action: "vim.api.nvim_buf_set_keymap(bufnr, 'n', '${binding.value}', '<cmd>lua ${action}<CR>', {noremap=true, silent=true, desc='${binding.description}'})";
|
||||||
in {
|
in {
|
||||||
config = mkIf cfg.enable {
|
config = mkIf cfg.enable {
|
||||||
vim.startPlugins = optional usingNvimCmp "cmp-nvim-lsp";
|
vim.startPlugins = optional usingNvimCmp "cmp-nvim-lsp";
|
||||||
|
|
||||||
vim.autocomplete.sources = {"nvim_lsp" = "[LSP]";};
|
vim.autocomplete.sources = {"nvim_lsp" = "[LSP]";};
|
||||||
|
|
||||||
vim.luaConfigRC.lsp-setup = ''
|
vim.luaConfigRC.lsp-setup = ''
|
||||||
vim.g.formatsave = ${boolToString cfg.formatOnSave};
|
vim.g.formatsave = ${boolToString cfg.formatOnSave};
|
||||||
|
|
||||||
local attach_keymaps = function(client, bufnr)
|
local attach_keymaps = function(client, bufnr)
|
||||||
local opts = { noremap=true, silent=true }
|
${mkBinding mappings.goToDeclaration "vim.lsp.buf.declaration()"}
|
||||||
|
${mkBinding mappings.goToDefinition "vim.lsp.buf.definition()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lgD', '<cmd>lua vim.lsp.buf.declaration()<CR>', opts)
|
${mkBinding mappings.goToDeclaration "vim.lsp.buf.declaration()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lgd', '<cmd>lua vim.lsp.buf.definition()<CR>', opts)
|
${mkBinding mappings.goToDefinition "vim.lsp.buf.definition()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lgt', '<cmd>lua vim.lsp.buf.type_definition()<CR>', opts)
|
${mkBinding mappings.goToType "vim.lsp.buf.type_definition()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lgn', '<cmd>lua vim.diagnostic.goto_next()<CR>', opts)
|
${mkBinding mappings.listImplementations "vim.lsp.buf.implementation()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lgp', '<cmd>lua vim.diagnostic.goto_prev()<CR>', opts)
|
${mkBinding mappings.listReferences "vim.lsp.buf.references()"}
|
||||||
|
${mkBinding mappings.nextDiagnostic "vim.diagnostic.goto_next()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lwa', '<cmd>lua vim.lsp.buf.add_workspace_folder()<CR>', opts)
|
${mkBinding mappings.previousDiagnostic "vim.diagnostic.goto_prev()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lwr', '<cmd>lua vim.lsp.buf.remove_workspace_folder()<CR>', opts)
|
${mkBinding mappings.openDiagnosticFloat "vim.diagnostic.open_float()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lwl', '<cmd>lua print(vim.inspect(vim.lsp.buf.list_workspace_folders()))<CR>', opts)
|
${mkBinding mappings.documentHighlight "vim.lsp.buf.document_highlight()"}
|
||||||
|
${mkBinding mappings.listDocumentSymbols "vim.lsp.buf.document_symbol()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>lh', '<cmd>lua vim.lsp.buf.hover()<CR>', opts)
|
${mkBinding mappings.addWorkspaceFolder "vim.lsp.buf.add_workspace_folder()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>ls', '<cmd>lua vim.lsp.buf.signature_help()<CR>', opts)
|
${mkBinding mappings.removeWorkspaceFolder "vim.lsp.buf.remove_workspace_folder()"}
|
||||||
vim.api.nvim_buf_set_keymap(bufnr, 'n', '<leader>ln', '<cmd>lua vim.lsp.buf.rename()<CR>', opts)
|
${mkBinding mappings.listWorkspaceFolders "print(vim.inspect(vim.lsp.buf.list_workspace_folders()))"}
|
||||||
|
${mkBinding mappings.listWorkspaceSymbols "vim.lsp.buf.workspace_symbol()"}
|
||||||
|
${mkBinding mappings.hover "vim.lsp.buf.hover()"}
|
||||||
|
${mkBinding mappings.signatureHelp "vim.lsp.buf.signature_help()"}
|
||||||
|
${mkBinding mappings.renameSymbol "vim.lsp.buf.rename()"}
|
||||||
|
${mkBinding mappings.codeAction "vim.lsp.buf.code_action()"}
|
||||||
|
${mkBinding mappings.format "vim.lsp.buf.format()"}
|
||||||
end
|
end
|
||||||
|
|
||||||
-- Enable formatting
|
-- Enable formatting
|
||||||
|
|
|
@ -1,13 +1,68 @@
|
||||||
{
|
{lib, ...}:
|
||||||
config,
|
|
||||||
lib,
|
|
||||||
pkgs,
|
|
||||||
...
|
|
||||||
}:
|
|
||||||
with lib;
|
with lib;
|
||||||
with builtins; {
|
with builtins; let
|
||||||
|
in {
|
||||||
options.vim.lsp = {
|
options.vim.lsp = {
|
||||||
enable = mkEnableOption "LSP, also enabled automatically through null-ls and lspconfig options";
|
enable = mkEnableOption "LSP, also enabled automatically through null-ls and lspconfig options";
|
||||||
formatOnSave = mkEnableOption "format on save";
|
formatOnSave = mkEnableOption "format on save";
|
||||||
|
mappings = {
|
||||||
|
goToDefinition =
|
||||||
|
mkMappingOption "Go to definition"
|
||||||
|
"<leader>lgd";
|
||||||
|
goToDeclaration =
|
||||||
|
mkMappingOption "Go to declaration"
|
||||||
|
"<leader>lgD";
|
||||||
|
goToType =
|
||||||
|
mkMappingOption "Go to type"
|
||||||
|
"<leader>lgt";
|
||||||
|
listImplementations =
|
||||||
|
mkMappingOption "List implementations"
|
||||||
|
"<leader>lgi";
|
||||||
|
listReferences =
|
||||||
|
mkMappingOption "List references"
|
||||||
|
"<leader>lgr";
|
||||||
|
nextDiagnostic =
|
||||||
|
mkMappingOption "Go to next diagnostic"
|
||||||
|
"<leader>lgn";
|
||||||
|
previousDiagnostic =
|
||||||
|
mkMappingOption "Go to previous diagnostic"
|
||||||
|
"<leader>lgp";
|
||||||
|
openDiagnosticFloat =
|
||||||
|
mkMappingOption "Open diagnostic float"
|
||||||
|
"<leader>le";
|
||||||
|
documentHighlight =
|
||||||
|
mkMappingOption "Document highlight"
|
||||||
|
"<leader>lH";
|
||||||
|
listDocumentSymbols =
|
||||||
|
mkMappingOption "List document symbols"
|
||||||
|
"<leader>lS";
|
||||||
|
addWorkspaceFolder =
|
||||||
|
mkMappingOption "Add workspace folder"
|
||||||
|
"<leader>lwa";
|
||||||
|
removeWorkspaceFolder =
|
||||||
|
mkMappingOption "Remove workspace folder"
|
||||||
|
"<leader>lwr";
|
||||||
|
listWorkspaceFolders =
|
||||||
|
mkMappingOption "List workspace folders"
|
||||||
|
"<leader>lwl";
|
||||||
|
listWorkspaceSymbols =
|
||||||
|
mkMappingOption "List workspace symbols"
|
||||||
|
"<leader>lws";
|
||||||
|
hover =
|
||||||
|
mkMappingOption "Trigger hover"
|
||||||
|
"<leader>lh";
|
||||||
|
signatureHelp =
|
||||||
|
mkMappingOption "Signature help"
|
||||||
|
"<leader>ls";
|
||||||
|
renameSymbol =
|
||||||
|
mkMappingOption "Rename symbol"
|
||||||
|
"<leader>ln";
|
||||||
|
codeAction =
|
||||||
|
mkMappingOption "Code action"
|
||||||
|
"<leader>la";
|
||||||
|
format =
|
||||||
|
mkMappingOption "Format"
|
||||||
|
"<leader>lf";
|
||||||
|
};
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue