mirror of
https://github.com/astral-sh/ruff.git
synced 2025-11-03 21:24:29 +00:00
9b43162cc4
## Summary We're planning to move the documentation from [https://beta.ruff.rs/docs](https://beta.ruff.rs/docs) to [https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), for a few reasons: 1. We want to remove the `beta` from the domain, as Ruff is no longer considered beta software. 2. We want to migrate to a structure that could accommodate multiple future tools living under one domain. The docs are actually already live at [https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), but later today, I'll add a permanent redirect from the previous to the new domain. **All existing links will continue to work, now and in perpetuity.** This PR contains the code changes necessary for the updated documentation. As part of this effort, I moved the playground and documentation from my personal Cloudflare account to our team Cloudflare account (hence the new `--project-name` references). After merging, I'll also update the secrets on this repo.
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
# flake8-to-ruff
|
|
|
|
Convert existing Flake8 configuration files (`setup.cfg`, `tox.ini`, or `.flake8`) for use with
|
|
[Ruff](https://github.com/astral-sh/ruff).
|
|
|
|
Generates a Ruff-compatible `pyproject.toml` section.
|
|
|
|
## Installation and Usage
|
|
|
|
### Installation
|
|
|
|
Available as [`flake8-to-ruff`](https://pypi.org/project/flake8-to-ruff/) on PyPI:
|
|
|
|
```shell
|
|
pip install flake8-to-ruff
|
|
```
|
|
|
|
### Usage
|
|
|
|
To run `flake8-to-ruff`:
|
|
|
|
```shell
|
|
flake8-to-ruff path/to/setup.cfg
|
|
flake8-to-ruff path/to/tox.ini
|
|
flake8-to-ruff path/to/.flake8
|
|
```
|
|
|
|
`flake8-to-ruff` will print the relevant `pyproject.toml` sections to standard output, like so:
|
|
|
|
```toml
|
|
[tool.ruff]
|
|
exclude = [
|
|
'.svn',
|
|
'CVS',
|
|
'.bzr',
|
|
'.hg',
|
|
'.git',
|
|
'__pycache__',
|
|
'.tox',
|
|
'.idea',
|
|
'.mypy_cache',
|
|
'.venv',
|
|
'node_modules',
|
|
'_state_machine.py',
|
|
'test_fstring.py',
|
|
'bad_coding2.py',
|
|
'badsyntax_*.py',
|
|
]
|
|
select = [
|
|
'A',
|
|
'E',
|
|
'F',
|
|
'Q',
|
|
]
|
|
ignore = []
|
|
|
|
[tool.ruff.flake8-quotes]
|
|
inline-quotes = 'single'
|
|
|
|
[tool.ruff.pep8-naming]
|
|
ignore-names = [
|
|
'foo',
|
|
'bar',
|
|
]
|
|
```
|
|
|
|
### Plugins
|
|
|
|
`flake8-to-ruff` will attempt to infer any activated plugins based on the settings provided in your
|
|
configuration file.
|
|
|
|
For example, if your `.flake8` file includes a `docstring-convention` property, `flake8-to-ruff`
|
|
will enable the appropriate [`flake8-docstrings`](https://pypi.org/project/flake8-docstrings/)
|
|
checks.
|
|
|
|
Alternatively, you can manually specify plugins on the command-line:
|
|
|
|
```shell
|
|
flake8-to-ruff path/to/.flake8 --plugin flake8-builtins --plugin flake8-quotes
|
|
```
|
|
|
|
## Limitations
|
|
|
|
1. 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.)
|
|
1. Ruff will omit any rule codes that are unimplemented or unsupported by Ruff, including rule
|
|
codes from unsupported plugins. (See the
|
|
[documentation](https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8) for the complete
|
|
list of supported plugins.)
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome and hugely appreciated. To get started, check out the
|
|
[contributing guidelines](https://github.com/astral-sh/ruff/blob/main/CONTRIBUTING.md).
|