FlakeHeaven

flakeheaven 是一个围绕 flake8 构建的 Python 代码检查器，以实现可继承和复杂的 toml 配置。

此项目是 FlakeHell 的分支。FlakeHell 和其他分支，如 flakehell/flakehell，已 不再维护 且不与 Flake8 4.0.x 兼容。

FlakeHeaven 与 Flake8 4.0.1 或更高版本兼容。此分支将由开发现有分支的社区 维护。

• 检查 md、rst、ipynb 等.
• 可分享和远程配置.
• 兼容性友好：仅获取关于新错误的报告。
• 缓存以提高性能。
• 仅使用指定的插件，而不是安装的所有内容。
• 使输出更美观.
• pyproject.toml 支持。
• 检查是否已安装所有必需的插件.
• 消息和代码片段的语法高亮.
• PyLint 集成。
• 强大的 GitLab 支持.
• 代码管理
  • 按插件管理代码。
  • 通过通配符启用和禁用插件及代码。
  • 显示已安装插件的代码.
  • 显示插件的全部消息和代码.
  • 允许不同插件间的代码交集。

兼容性

FlakeHeaven 支持所有 flake8 插件、格式化器和配置。然而，FlakeHeaven 有自己独特的配置已启用插件和代码的方式。因此，如 --ignore 和 --select 这样的选项不受支持。如果您希望在一个项目中同时使用 flake8 和 FlakeHeaven，则需要明确指定启用的插件。

安装

python3 -m pip install --user flakeheaven

用法

首先，让我们创建 pyproject.toml 配置文件

[tool.flakeheaven]
# optionally inherit from remote config (or local if you want)
base = "https://raw.githubusercontent.com/flakeheaven/flakeheaven/main/pyproject.toml"
# specify any flake8 options. For example, exclude "example.py":
exclude = ["example.py"]
# make output nice
format = "grouped"
# 80 chars aren't enough in 21 century
max_line_length = 90
# show line of source code in output
show_source = true

# list of plugins and rules for them
[tool.flakeheaven.plugins]
# include everything in pyflakes except F401
pyflakes = ["+*", "-F401"]
# enable only codes from S100 to S199
flake8-bandit = ["-*", "+S1??"]
# enable everything that starts from `flake8-`
"flake8-*" = ["+*"]
# explicitly disable plugin
flake8-docstrings = ["-*"]

显示尚未安装的插件

flakeheaven missed

显示已安装的插件、使用的插件、指定的规则、代码前缀

flakeheaven plugins

显示特定插件的代码和消息

flakeheaven codes pyflakes

对代码运行 flake8

flakeheaven lint

此命令接受与 Flake8 相同的所有参数。

阅读 文档 获取更多信息。

贡献

1. 尽可能添加测试（例如，对于功能、修复、重构等）
2. 将您的贡献添加到代码/文档中
3. 确保您的代码通过所有（包括原始和您自己的）测试。
4. 使用 适当的大纲 提交
5. 创建 PR

欢迎贡献！以下是一些建议，您可以在其中贡献

• 改进文档。
• 添加更多测试。
• 提高性能。
• 发现了bug？修复它！
• 撰写了关于 FlakeHeaven 的文章？太好了！让我们将其添加到 README.md 中。
• 没有时间编写代码？没关系！只需告诉您的朋友和订阅者有关该项目的信息。用户越多 -> 贡献者越多 -> 更酷的功能。

使用 Poetry 运行测试是一种便捷的方式

curl -sSL https://install.python-poetry.org | python3 -
poetry install
poetry run pytest tests

谢谢 :heart

FlakeHeaven 的吉祥物（Flaky）由 @illustrator.way 创作并授权于 CC BY-SA 4.0 许可。