flake8-to-ruff

[!WARNING]

flake8-to-ruff不再受支持。您在使用版本号高于v0.0.233的Ruff时可能会遇到警告或损坏。

将现有的Flake8配置文件（setup.cfg、tox.ini或.flake8）转换为用于Ruff的格式。

生成兼容Ruff的pyproject.toml部分。

安装和使用

安装

作为PyPI上的flake8-to-ruff提供

pip install flake8-to-ruff

使用方法

运行flake8-to-ruff

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

flake8-to-ruff将打印相关的pyproject.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',
]

插件

flake8-to-ruff将尝试根据配置文件中提供的设置推断任何已激活的插件。

例如，如果您的 .flake8 文件包含一个 docstring-convention 属性，则 flake8-to-ruff 将启用适当的 flake8-docstrings 检查。

或者，您可以在命令行上手动指定插件

flake8-to-ruff path/to/.flake8 --plugin flake8-builtins --plugin flake8-quotes

局限性

1. Ruff 仅支持 Flake 配置选项的一个子集。《code>flake8-to-ruff 将在 .flake8 文件（或等效）中警告并忽略不受支持的选项。（同样，Ruff 也有一些配置选项在 Flake8 中不存在。）
2. Ruff 将省略任何未实现或不受 Ruff 支持的规则代码，包括不受支持的插件的规则代码。（有关支持插件的完整列表，请参阅 Ruff README。）

许可

MIT 协议

贡献

欢迎并高度重视贡献。要开始，请查看 贡献指南。