Ruff linting plugin for pylsp
Project description
python-lsp-ruff
Linter plugin for pylsp based using ruff.
Formatting via ruff
's --fix
is available since v1.3.0.
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
and mccabe
by default.
When enabled, all linting diagnostics will be provided by ruff
.
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 optionalpyproject.toml
file.pylsp.plugins.ruff.exclude
: Exclude files from being checked byruff
.pylsp.plugins.ruff.executable
: Path to theruff
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.
For more information on the configuration visit Ruff's homepage.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_lsp_ruff-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad14f6f445502fb28af3e5c8de30cf9029b3cfc0af64d768f8680e84b1778817 |
|
MD5 | c0103e4c13b57fb2924f169a5c584770 |
|
BLAKE2b-256 | 5cb6c2428a3759b814a1cd72d65d030410b3e67a4105d90b0fe5114c629b47d2 |