Skip to content

README.md

Latest commit

 

History

History
70 lines (54 loc) · 3.23 KB

README.md

File metadata and controls

70 lines (54 loc) · 3.23 KB

python-lsp-ruff

PyPi Anaconda Python

python-lsp-ruff is a plugin for python-lsp-server that adds linting, code action and formatting capabilities that are provided by ruff, a extremely fast Python linter, written in Rust.

Install

In the same virtualenv as python-lsp-server:

pip install python-lsp-ruff

There also exists an AUR package.

Usage

This plugin will disable flake8, pycodestyle, pyflakes, mccabe and pyls_isort by default. When enabled, all linting diagnostics will be provided by ruff. Sorting of the imports through ruff when formatting is enabled by default. The list of code fixes can be changed via the pylsp.plugins.ruff.format option.

Any codes given in the format option will only be marked as fixable for ruff during the formatting operation, the user has to make sure that these codes are also in the list of codes that ruff checks!

This example configuration for neovim shows how to always sort imports when running textDocument/formatting:

lspconfig.pylsp.setup {
	settings = {
		pylsp = {
			plugins = {
				ruff = {
					enabled = true,
					extendSelect = { "I" },
				},
			}
		}
	}
}

Configuration

Configuration options can be passed to the python-language-server. If a pyproject.toml file is present in the project, python-lsp-ruff will use these configuration options. Note that any configuration options (except for extendIgnore and extendSelect, see this issue) passed to ruff via pylsp are ignored if the project has a pyproject.toml.

The plugin follows python-lsp-server's configuration. These are the valid configuration keys:

  • pylsp.plugins.ruff.enabled: boolean to enable/disable the plugin. true by default.
  • pylsp.plugins.ruff.config: Path to optional pyproject.toml file.
  • pylsp.plugins.ruff.exclude: Exclude files from being checked by ruff.
  • pylsp.plugins.ruff.executable: Path to the ruff executable. Assumed to be in PATH by default.
  • pylsp.plugins.ruff.ignore: Error codes to ignore.
  • pylsp.plugins.ruff.extendIgnore: Same as ignore, but append to existing ignores.
  • pylsp.plugins.ruff.lineLength: Set the line-length for length checks.
  • pylsp.plugins.ruff.perFileIgnores: File-specific error codes to be ignored.
  • pylsp.plugins.ruff.select: List of error codes to enable.
  • pylsp.plugins.ruff.extendSelect: Same as select, but append to existing error codes.
  • pylsp.plugins.ruff.format: List of error codes to fix during formatting. The default is ["I"], any additional codes are appended to this list.

For more information on the configuration visit Ruff's homepage.