Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

plugins.lsp.servers.pylsp.settings.plugins.ruff.enabled

Enable or disable the plugin. Setting this explicitly to true will install the dependency for this plugin (python-lsp-ruff).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.config

Path to optional pyproject.toml file.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.exclude

Exclude files from being checked by ruff.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.executable

Path to the ruff executable. Assumed to be in PATH by default.

Type: null or string

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.extendIgnore

Same as ignore, but append to existing ignores.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.extendSelect

Same as select, but append to existing error codes.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.format

List of error codes to fix during formatting. The default is [ā€œIā€], any additional codes are appended to this list.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.ignore

Error codes to ignore.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.lineLength

Set the line-length for length checks.

Type: null or signed integer

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.perFileIgnores

File-specific error codes to be ignored.

Type: null or (attribute set of list of string)

Default: null

Declared by:

plugins.lsp.servers.pylsp.settings.plugins.ruff.select

List of error codes to enable.

Type: null or (list of (string or raw lua code)) or raw lua code

Default: null

Plugin default: [ ]

Declared by: