metals

URL: https://scalameta.org/metals/

plugins.lsp.servers.metals.enable

Whether to enable https://scalameta.org/metals/

Scala language server with rich IDE features.

See full instructions in the Metals documentation:

https://scalameta.org/metals/docs/editors/vim#using-an-alternative-lsp-client

Note: that if you’re using nvim-metals, that plugin fully handles the setup and installation of Metals, and you shouldn’t set up Metals both with it and lspconfig.

To install Metals, make sure to have coursier installed, and once you do you can install the latest Metals with cs install metals. .

Type: boolean

Default: false

Example: true

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.package

The metals package to use.

Type: null or package

Default: pkgs.metals

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.autostart

Controls if the FileType autocommand that launches a language server is created. If false, allows for deferring language servers until manually launched with :LspStart (|lspconfig-commands|).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.cmd

A list where each entry corresponds to the blankspace delimited part of the command that launches the server.

The first entry is the binary used to run the language server. Additional entries are passed as arguments.

Type: null or (list of string)

Default: null when package is null, otherwise null

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.extraOptions

Extra options for the metals language server.

Type: attribute set of anything

Default: { }

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.filetypes

Set of filetypes for which to attempt to resolve {root_dir}. May be empty, or server may specify a default value.

Type: null or (list of string)

Default: null

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.rootDir

A function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server.

Type: null or lua function string

Default: null

Plugin default: "nil"

Declared by:

• <nixvim/plugins/lsp/language-servers>

plugins.lsp.servers.metals.settings

The settings for this LSP.

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

• <nixvim/plugins/lsp/language-servers>