NEOVIM.md

Neovim Setup Guide for ruff server

Using nvim-lspconfig

1. Install nvim-lspconfig.
2. Setup nvim-lspconfig with the suggested configuration.
3. Finally, add this to your init.lua:

require('lspconfig').ruff.setup {}

See nvim-lspconfig's server configuration guide for more details on how to configure the server from there.

Important

If you have the older language server (ruff-lsp) configured in Neovim, make sure to disable it to prevent any conflicts.

Tips

If you're using Ruff alongside another LSP (like Pyright), you may want to defer to that LSP for certain capabilities, like textDocument/hover:

local on_attach = function(client, bufnr)
  if client.name == 'ruff' then
    -- Disable hover in favor of Pyright
    client.server_capabilities.hoverProvider = false
  end
end

require('lspconfig').ruff.setup {
  on_attach = on_attach,
}

If you'd like to use Ruff exclusively for linting, formatting, and import organization, you can disable those capabilities for Pyright:

require('lspconfig').pyright.setup {
  settings = {
    pyright = {
      -- Using Ruff's import organizer
      disableOrganizeImports = true,
    },
    python = {
      analysis = {
        -- Ignore all files for analysis to exclusively use Ruff for linting
        ignore = { '*' },
      },
    },
  },
}

By default, Ruff will not show any logs. To enable logging in Neovim, you'll need to set the RUFF_TRACE environment variable to either messages or verbose:

require('lspconfig').ruff.setup {
  cmd_env = { RUFF_TRACE = "messages" }
}

You can set the log level in settings:

require('lspconfig').ruff.setup {
  cmd_env = { RUFF_TRACE = "messages" },
  init_options = {
    settings = {
      logLevel = "debug",
    }
  }
}

It's also possible to divert Ruff's logs to a separate file with the logFile setting:

require('lspconfig').ruff.setup {
  cmd_env = { RUFF_TRACE = "messages" },
  init_options = {
    settings = {
      logLevel = "debug",
      logFile = "~/.config/nvim/logs/ruff_logs.txt"
    }
  }
}