mirror of https://github.com/astral-sh/ruff.git synced 2025-09-26 11:59:10 +00:00

History

Charlie Marsh 79ca66ace5 Use nightly rustfmt with rustfmt.toml (#536 )		2022-11-01 20:34:38 -04:00
..
src	Use nightly rustfmt with rustfmt.toml (#536 )	2022-11-01 20:34:38 -04:00
Cargo.lock	Bump version to 0.0.94	2022-11-01 16:38:59 -04:00
Cargo.toml	Bump version to 0.0.94	2022-11-01 16:38:59 -04:00
pyproject.toml	Add to flake8-to-ruff README	2022-10-31 17:50:32 -04:00
README.md	Add to flake8-to-ruff README	2022-10-31 17:50:32 -04:00

flake8-to-ruff

Convert existing Flake8 configuration files (setup.cfg, tox.ini, or .flake8) for use with Ruff.

Generates a Ruff-compatible pyproject.toml section.

Installation and Usage

Available as flake8-to-ruff on PyPI:

pip install flake8-to-ruff

To run Ruff, try any of the following:

flake8-to-ruff path/to/setup.cfg
flake8-to-ruff path/to/tox.ini
flake8-to-ruff path/to/.flake8

Ruff only supports a subset of the Flake configuration options. flake8-to-ruff will warn on and ignore unsupported options in the .flake8 file (or equivalent). (Similarly, Ruff has a few configuration options that don't exist in Flake8.)
Ruff will omit any error codes that are unimplemented or unsupported by Ruff, including error codes from unsupported plugins. (See the Ruff README for the complete list of supported plugins.)
flake8-to-ruff does not auto-detect your Flake8 plugins, so any reliance on Flake8 plugins that implicitly enable third-party checks will be ignored. Instead, add those error codes to your select or extend-select fields, so that flake8-to-ruff can pick them up.

MIT

Contributions are welcome and hugely appreciated. To get started, check out the contributing guidelines.