nvim-metals is a Lua plugin built to provide a better experience while using Metals, the Scala Language Server, with Neovim's built-in LSP support.¹ You can see all the available features here.

• Before you get started you need to ensure that you are using the latest nvim v.0.10.x or newer. If you're still on v0.9.x then you'll want to target the v0.9.x tag.
• Ensure Coursier is installed locally.²
• Ensure that you have all the LSP mappings for the core functionality you want setup.³
• Ensure plenary.nvim is installed.⁴
• Subscribe to this discussion which will notify you of any breaking changes.
• Unfamiliar with Lua and Neovim? Check out the great :h lua-guide.

NOTE: This plugin works without needing to install neovim/nvim-lspconfig. If you have it installed for other languages, that's not a problem, but make sure you do not have Metals configured through nvim-lspconfig while using this plugin.¹

{
  "scalameta/nvim-metals",
  dependencies = {
    "nvim-lua/plenary.nvim",
  },
  ft = { "scala", "sbt", "java" },
  opts = function()
    local metals_config = require("metals").bare_config()
    metals_config.on_attach = function(client, bufnr)
      -- your on_attach function
    end

    return metals_config
  end,
  config = function(self, metals_config)
    local nvim_metals_group = vim.api.nvim_create_augroup("nvim-metals", { clear = true })
    vim.api.nvim_create_autocmd("FileType", {
      pattern = self.ft,
      callback = function()
        require("metals").initialize_or_attach(metals_config)
      end,
      group = nvim_metals_group,
    })
  end
}

NOTE: The above assumes you have your own attach function that sets up all your LSP mappings. It also doesn't make use of any configuration. You'll likely want a more involved setup than this, so check out the full minimal example configuration link below.

• You can find a full minimal example configuration here.
• You can find the full documentation with :help nvim-metals.
• You can find a full list of features here.

To view all of the available commands, check out :help metals-commands in the help docs. Similarly, to see the available configuration settings check out :help metals-settings.

To see the full details on the available configurations, checkout out :help metals-integrations. The currently available integrations are:

• nvim-dap
• Telescope