clangd_extension overwrite lspconfig's keymapping

[Bekaboo]

nvim-lspconfig has a on_attach config for users to define custom keymappings and actions when an lsp client attaches to current buffer, for example:

local function on_attach(client, bufnr)

    -- Enable completion triggered by <c-x><c-o>
    local buf_set_option = function(...) vim.api.nvim_buf_set_option(bufnr, ...) end
    buf_set_option('omnifunc', 'v:lua.vim.lsp.omnifunc')

    -- Use an on_attach function to only map the following keys
    -- after the language server attaches to the current buffer
    local keymaps = {
      { 'n', 'gD', '<cmd>lua vim.lsp.buf.declaration()<CR>' },
      { 'n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>' },
      { 'n', 'K', '<cmd>lua vim.lsp.buf.hover()<CR>' },
      { 'n', '<leader>ls', '<cmd>lua vim.lsp.buf.signature_help()<CR>' },
      { 'n', '<Leader>li', '<cmd>lua vim.lsp.buf.implementation()<CR>' },
      { 'n', '<Leader>wa', '<cmd>lua vim.lsp.buf.add_workspace_folder()<CR>' },
      { 'n', '<Leader>wd', '<cmd>lua vim.lsp.buf.remove_workspace_folder()<CR>' },
      { 'n', '<Leader>wl', '<cmd>lua vim.pretty_print(vim.lsp.buf.list_workspace_folders())<CR>' },
      { 'n', '<leader>td', '<cmd>lua vim.lsp.buf.type_definition()<CR>' },
      { 'n', '<Leader>r', '<cmd>lua vim.lsp.buf.rename()<CR>' },
      { 'n', '<Leader>ca', '<cmd>lua vim.lsp.buf.code_action()<CR>' },
      { 'n', '<Leader>R', '<cmd>lua vim.lsp.buf.references()<CR>' },
      { 'n', '<Leader>e', '<cmd>lua vim.diagnostic.open_float()<CR>' },
      { 'n', '[E', '<cmd>lua vim.diagnostic.goto_prev({ severity = vim.diagnostic.severity.ERROR })<CR>' },
      { 'n', ']E', '<cmd>lua vim.diagnostic.goto_next({ severity = vim.diagnostic.severity.ERROR })<CR>' },
      { 'n', '[e', '<cmd>lua vim.diagnostic.goto_prev()<CR>' },
      { 'n', ']e', '<cmd>lua vim.diagnostic.goto_next()<CR>' },
      { 'n', '<leader>ll', '<cmd>lua vim.diagnostic.setloclist()<CR>' },
      { 'n', '==', '<cmd>lua vim.lsp.buf.format()<CR>' },
      { 'x', '=', '<cmd>lua vim.lsp.buf.format()<CR>' },
    }
    for _, map in ipairs(keymaps) do
      -- use <unique> to avoid overriding telescope keymaps
      vim.cmd(string.format('silent! %snoremap <buffer> <silent> <unique> %s %s',
            unpack(map)))
    end

    -- integration with nvim-navic
    if client.server_capabilities.documentSymbolProvider then
      local status, navic = pcall(require, 'nvim-navic')
      if status then
        navic.attach(client, bufnr)
      end
    end
  end

then this on_attach function is passed to require('lspconfig')[server_name].setup().

However, it seems that clangd_extensions will overwrite the on_attach function because the keymaps (gd, K, ]e, ... etc) no longer functions after installing this plugin.

I've tried passing the on_attach function to this plugin in the server entry but it does not work.

Below is my config for nvim-lspconfig and clangd_extensions.nvim:

config for nvim-lspconfig:

  local static = require('utils.static')
  local ensure_installed = static.langs:list('lsp_server')
  local icons = static.icons

  local function lspconfig_setui()
    -- Customize LSP floating window border
    local floating_preview_opts = { border = 'single' }
    local orig_util_open_floating_preview = vim.lsp.util.open_floating_preview
    function vim.lsp.util.open_floating_preview(contents, syntax, opts, ...)
      opts = vim.tbl_deep_extend('force', opts, floating_preview_opts)
      return orig_util_open_floating_preview(contents, syntax, opts, ...)
    end
    local diagnostic_opts = {}
    -- LSP diagnostic signs
    diagnostic_opts.signs = {
      { 'DiagnosticSignError', { text = icons.DiagnosticSignError, texthl = 'DiagnosticSignError', numhl = 'DiagnosticSignError' } },
      { 'DiagnosticSignWarn', { text = icons.DiagnosticSignWarn, texthl = 'DiagnosticSignWarn', numhl = 'DiagnosticSignWarn' } },
      { 'DiagnosticSignInfo', { text = icons.DiagnosticSignInfo, texthl = 'DiagnosticSignInfo', numhl = 'DiagnosticSignInfo' } },
      { 'DiagnosticSignHint', { text = icons.DiagnosticSignHint, texthl = 'DiagnosticSignHint', numhl = 'DiagnosticSignHint' } },
    }
    for _, sign_settings in ipairs(diagnostic_opts.signs) do
      vim.fn.sign_define(unpack(sign_settings))
    end
    diagnostic_opts.handlers = {
      -- Enable underline, use default values
      underline = true,
      -- Enable virtual text, override spacing to 4
      virtual_text = {
        spacing = 4,
        prefix = ''
      },
    }
    vim.lsp.handlers['textDocument/publishDiagnostics']
        = vim.lsp.with(vim.lsp.diagnostic.on_publish_diagnostics,
                       diagnostic_opts.handlers)
  end

  local function on_attach(client, bufnr)

    -- Enable completion triggered by <c-x><c-o>
    local buf_set_option = function(...) vim.api.nvim_buf_set_option(bufnr, ...) end
    buf_set_option('omnifunc', 'v:lua.vim.lsp.omnifunc')

    -- Use an on_attach function to only map the following keys
    -- after the language server attaches to the current buffer
    local keymaps = {
      { 'n', 'gD', '<cmd>lua vim.lsp.buf.declaration()<CR>' },
      { 'n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>' },
      { 'n', 'K', '<cmd>lua vim.lsp.buf.hover()<CR>' },
      { 'n', '<leader>ls', '<cmd>lua vim.lsp.buf.signature_help()<CR>' },
      { 'n', '<Leader>li', '<cmd>lua vim.lsp.buf.implementation()<CR>' },
      { 'n', '<Leader>wa', '<cmd>lua vim.lsp.buf.add_workspace_folder()<CR>' },
      { 'n', '<Leader>wd', '<cmd>lua vim.lsp.buf.remove_workspace_folder()<CR>' },
      { 'n', '<Leader>wl', '<cmd>lua vim.pretty_print(vim.lsp.buf.list_workspace_folders())<CR>' },
      { 'n', '<leader>td', '<cmd>lua vim.lsp.buf.type_definition()<CR>' },
      { 'n', '<Leader>r', '<cmd>lua vim.lsp.buf.rename()<CR>' },
      { 'n', '<Leader>ca', '<cmd>lua vim.lsp.buf.code_action()<CR>' },
      { 'n', '<Leader>R', '<cmd>lua vim.lsp.buf.references()<CR>' },
      { 'n', '<Leader>e', '<cmd>lua vim.diagnostic.open_float()<CR>' },
      { 'n', '[E', '<cmd>lua vim.diagnostic.goto_prev({ severity = vim.diagnostic.severity.ERROR })<CR>' },
      { 'n', ']E', '<cmd>lua vim.diagnostic.goto_next({ severity = vim.diagnostic.severity.ERROR })<CR>' },
      { 'n', '[e', '<cmd>lua vim.diagnostic.goto_prev()<CR>' },
      { 'n', ']e', '<cmd>lua vim.diagnostic.goto_next()<CR>' },
      { 'n', '<leader>ll', '<cmd>lua vim.diagnostic.setloclist()<CR>' },
      { 'n', '==', '<cmd>lua vim.lsp.buf.format()<CR>' },
      { 'x', '=', '<cmd>lua vim.lsp.buf.format()<CR>' },
    }
    for _, map in ipairs(keymaps) do
      -- use <unique> to avoid overriding telescope keymaps
      vim.cmd(string.format('silent! %snoremap <buffer> <silent> <unique> %s %s',
            unpack(map)))
    end

    -- integration with nvim-navic
    if client.server_capabilities.documentSymbolProvider then
      local status, navic = pcall(require, 'nvim-navic')
      if status then
        navic.attach(client, bufnr)
      end
    end
  end

  local function get_override_config(name)
    local status, override_config
      = pcall(require, 'modules.lsp.lsp-server-configs.' .. name)
    if not status then
      return nil
    else
      return override_config.on_new_config
    end
  end

  local function lsp_setup()
    -- Add additional capabilities
    local capabilities = vim.lsp.protocol.make_client_capabilities()
    capabilities.offsetEncoding = 'utf-8'
    local cmp_nvim_lsp_ok, cmp_nvim_lsp = pcall(require, 'cmp_nvim_lsp')
    if cmp_nvim_lsp_ok then
      capabilities = cmp_nvim_lsp.default_capabilities(capabilities)
    end
    for _, server_name in pairs(ensure_installed) do
      require('lspconfig')[server_name].setup({
        on_attach = on_attach,
        capabilities = capabilities,
        on_new_config = get_override_config(server_name),
      })
    end
  end

  lspconfig_setui()
  lsp_setup()

config for clangd_extensions:

  local icons = require('utils.static').icons
  require('clangd_extensions').setup({
    extensions = {
      ast = {
        role_icons = {
          ['type'] = icons.Type,
          ['declaration'] = icons.Function,
          ['expression'] = icons.Snippet,
          ['specifier'] = icons.Specifier,
          ['statement'] = icons.Statement,
          ['template argument'] = icons.TypeParameter,
        },
        kind_icons = {
          ['Compound'] = icons.Namespace,
          ['Recovery'] = icons.DiagnosticSignError,
          ['TranslationUnit'] = icons.Unit,
          ['PackExpansion'] = icons.Ellipsis,
          ['TemplateTypeParm'] = icons.TypeParameter,
          ['TemplateTemplateParm'] = icons.TypeParameter,
          ['TemplateParamObject'] = icons.TypeParameter,
        },
      },
      memory_usage = {
        border = 'none',
      },
      symbol_info = {
        border = 'none',
      },
    },
  })

[p00f]

You need to call your "normal" on_attach in clangd's on_attach:

  local icons = require('utils.static').icons
  require('clangd_extensions').setup({
    server = {
        on_attach = function(client, bufnr)
            my_on_attach(client, bufnr)
            -- other clangd-specific stuff here
        end
    }
    extensions = {
      ast = {
        role_icons = {
          ['type'] = icons.Type,
          ['declaration'] = icons.Function,
          ['expression'] = icons.Snippet,
          ['specifier'] = icons.Specifier,
          ['statement'] = icons.Statement,
          ['template argument'] = icons.TypeParameter,
        },
        kind_icons = {
          ['Compound'] = icons.Namespace,
          ['Recovery'] = icons.DiagnosticSignError,
          ['TranslationUnit'] = icons.Unit,
          ['PackExpansion'] = icons.Ellipsis,
          ['TemplateTypeParm'] = icons.TypeParameter,
          ['TemplateTemplateParm'] = icons.TypeParameter,
          ['TemplateParamObject'] = icons.TypeParameter,
        },
      },
      memory_usage = {
        border = 'none',
      },
      symbol_info = {
        border = 'none',
      },
    },
  })

[Bekaboo]

Thanks for replying!

I followed you suggestion and come up with this config:

local function on_attach(client, bufnr)
  vim.notify('Read on_attach', vim.log.levels.INFO)

  -- Enable completion triggered by <c-x><c-o>
  local buf_set_option = function(...) vim.api.nvim_buf_set_option(bufnr, ...) end
  buf_set_option('omnifunc', 'v:lua.vim.lsp.omnifunc')

  -- Use an on_attach function to only map the following keys
  -- after the language server attaches to the current buffer
  local keymaps = {
    { 'n', 'gD', '<cmd>lua vim.lsp.buf.declaration()<CR>' },
    { 'n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>' },
    { 'n', 'K', '<cmd>lua vim.lsp.buf.hover()<CR>' },
    { 'n', '<leader>ls', '<cmd>lua vim.lsp.buf.signature_help()<CR>' },
    { 'n', '<Leader>li', '<cmd>lua vim.lsp.buf.implementation()<CR>' },
    { 'n', '<Leader>wa', '<cmd>lua vim.lsp.buf.add_workspace_folder()<CR>' },
    { 'n', '<Leader>wd', '<cmd>lua vim.lsp.buf.remove_workspace_folder()<CR>' },
    { 'n', '<Leader>wl', '<cmd>lua vim.pretty_print(vim.lsp.buf.list_workspace_folders())<CR>' },
    { 'n', '<leader>td', '<cmd>lua vim.lsp.buf.type_definition()<CR>' },
    { 'n', '<Leader>r', '<cmd>lua vim.lsp.buf.rename()<CR>' },
    { 'n', '<Leader>ca', '<cmd>lua vim.lsp.buf.code_action()<CR>' },
    { 'n', '<Leader>R', '<cmd>lua vim.lsp.buf.references()<CR>' },
    { 'n', '<Leader>e', '<cmd>lua vim.diagnostic.open_float()<CR>' },
    { 'n', '[E', '<cmd>lua vim.diagnostic.goto_prev({ severity = vim.diagnostic.severity.ERROR })<CR>' },
    { 'n', ']E', '<cmd>lua vim.diagnostic.goto_next({ severity = vim.diagnostic.severity.ERROR })<CR>' },
    { 'n', '[e', '<cmd>lua vim.diagnostic.goto_prev()<CR>' },
    { 'n', ']e', '<cmd>lua vim.diagnostic.goto_next()<CR>' },
    { 'n', '<leader>ll', '<cmd>lua vim.diagnostic.setloclist()<CR>' },
    { 'n', '==', '<cmd>lua vim.lsp.buf.format()<CR>' },
    { 'x', '=', '<cmd>lua vim.lsp.buf.format()<CR>' },
  }
  for _, map in ipairs(keymaps) do
    -- use <unique> to avoid overriding telescope keymaps
    vim.cmd(string.format('silent! %snoremap <buffer> <silent> <unique> %s %s',
          unpack(map)))
  end

  -- integration with nvim-navic
  if client.server_capabilities.documentSymbolProvider then
    local status, navic = pcall(require, 'nvim-navic')
    if status then
      navic.attach(client, bufnr)
    end
  end
end

local icons = require('utils.static').icons

  require('clangd_extensions').setup({
    server = {
      on_attach = function(client, bufnr)
        on_attach(client, bufnr)
      end
    },
    extensions = {
      ast = {
        role_icons = {
          ['type'] = icons.Type,
          ['declaration'] = icons.Function,
          ['expression'] = icons.Snippet,
          ['specifier'] = icons.Specifier,
          ['statement'] = icons.Statement,
          ['template argument'] = icons.TypeParameter,
        },
        kind_icons = {
          ['Compound'] = icons.Namespace,
          ['Recovery'] = icons.DiagnosticSignError,
          ['TranslationUnit'] = icons.Unit,
          ['PackExpansion'] = icons.Ellipsis,
          ['TemplateTypeParm'] = icons.TypeParameter,
          ['TemplateTemplateParm'] = icons.TypeParameter,
          ['TemplateParamObject'] = icons.TypeParameter,
        },
      },
      memory_usage = {
        border = 'none',
      },
      symbol_info = {
        border = 'none',
      },
    },
  })

but I get this error everytime I enter a c/cpp file:

Error executing vim.schedule lua callback: [string "..."]:0: attempt to call upvalue '' (a nil value)
stack traceback:
        [string "..."]: in function 'old_func'
        ...pt/clangd_extensions.nvim/lua/clangd_extensions/init.lua:21: in function '_on_attach'
        ...pack/packer/opt/nvim-lspconfig/lua/lspconfig/configs.lua:294: in function '_setup_buffer'
        ...pack/packer/opt/nvim-lspconfig/lua/lspconfig/configs.lua:198: in function ''
        vim/_editor.lua: in function <vim/_editor.lua:0>

Do you have any clue on this? Thanks!

[Bekaboo]

I also noticed that if I replace

local function on_attach(client, bufnr)
    ...
end

require('clangd_extensions').setup({
    server = { on_attach = function(client, bufnr) on_attach(client, bufnr) end },
    ...
})

with

local function on_attach(client, bufnr)
    ...
end

require('clangd_extensions').setup({
    server = { on_attach = on_attach },
    ...
})

the error no longer exists, but the keymaps defined in on_attach function still refuse to work, don't know why...

[p00f]

I have no idea but since everything is working for you I'll close this