[Neovim] How to organize imports on save (with configuration options)

[drewlwhitney]

Hello!

In Neovim, how can I configure Ruff to automatically sort imports on file save? I have the following in my init.lua file:

vim.lsp.config("ruff", {
    init_options = {
        settings = {
            lineLength = 100,
            configurationPreference = "filesystemFirst",
            configuration = {
                fix = true,
                format = {
                    ["docstring-code-format"] = true,
                },
                lint = {
                    isort = {
                        ["combine-as-imports"] = true,
                    },
                    pycodestyle = {
                        ["max-doc-length"] = 100,
                    },
                    pydocstyle = {
                        convention = "numpy",
                    },
                },
            },
        },
    },
})
vim.lsp.enable("ruff")

and I have conform.nvim installed and configured to use the LSP (Ruff) formatter. I've read that sorting imports is part of the linter, so in the command line you have to pass --fix to make Ruff sort imports. Does fix = true not cause that option to get passed?

Formatting works fine, but import sorting does not happen.

I know I could use conform.nvim with something like

 formatters_by_ft = {
    python = { "ruff_fix", "ruff_organize_imports", "ruff_format" }
}

to make this happen, but then the combine-as-imports option is not respected.

Thank you!

[dhruvmanila]

but then the combine-as-imports option is not respected.

This is expected because conform.nvim uses the command-line to invoke ruff executable. So, the language server is a different interface than the command-line and the settings that you pass to the language server via vim.lsp.config is only recognized by the server that's running in the background. While conform.nvim will invoke the ruff command on each run. This is why ruff as run via conform.nvim will not pickup the options specified in vim.lsp.config. Does that make sense?

There are couple of solutions:

1. If you intend to use Ruff both via command-line and the language server, then it's best to configure it via pyproject.toml / ruff.toml / .ruff.toml so that it can be picked up by both and a single configuration is shared across the interface
2. If you want to keep the configuration local in the vim.lsp.config, then you'd need to define an autocmd to run the code action (provided by the language server) on every save. There's a code snippet here that should help: Neovim - issue with configuration/configurationPreference #12514 (comment)

[drewlwhitney]

Sorry for the delayed response. The ruff.toml file works perfectly. Thank you for the tip!

[dhruvmanila]

Np! Thanks for letting us know :)