Breaking Changes & News: Follow for Updates

[mjlbach]

Please follow this issue if you would like to be updated on breaking changes and news for lspconfig.

[mjlbach]

Neovim 0.7 is out today. Two major improvements are the lua autocommands and lua user_commands API. I'm planning on merging #1838 within the next week which will break backwards compatibility with Neovim < 0.7. This will be the first minor patch version update of lspconfig (we follow semantic versioning) to lspconfig 0.2.0.

There will be two breaking changes in the update.

• Neovim 0.6 compatibility will be dropped to allow passing closures via the lua autocommands API, this dramatically simplifies the lspconfig codebase in certain parts.
• The commands field of setup will be renamed user_commands to distinguish from the commands field that start_client takes. The new user_commands field will have a different structure, instead taking a list of tables of the form that matches vim.api.nvim_create_user_command

  user_commands = {
     {
      name = "TexlabBuild"
      command = function()
        buf_build(0)
      end,
      opts = {
         desc = "Build the current buffer",
      }
    },
  },

You can follow #1838 to know when it is merged, and leave feedback if you disagree with the change to user_commands.

I won't consider a backport branch for 0.6 compatibility, you will need to pin to lspconfig's release branch v0.1.3

Here is how you can pin with packer.nvim:

use {
    'neovim/nvim-lspconfig',
    tag = 'v0.1.3',
}

and with vim-plug:

Plug 'neovim/nvim-lspconfig', { 'tag': 'v0.1.3' }