Linting

In-editor

There are two types of linting diagnostics: Lint errors (each of which corresponds to a rule) and syntax errors. The latter is not reported by default, as it is expected that the same errors are already reported by the IDE.

Command line mode

In Command line mode, the executable is invoked after every keystroke.

This is equivalent to running ruff check --no-fix with the file as input.

LSP modes

In LSP modes, diagnostics are sent to the client via textDocument/publishDiagnostics notifications.

Batch inspection

RyeCharm also supports running Ruff using Inspect Code..., also known as batch inspection mode.

This is equivalent to running ruff check at the project directory.

Warning

If there are unsaved changes, the returned diagnostics may be out-of-date.