scibi/flakeheaven

flakeheaven is a python linter built around flake8 to enable inheritable and complex toml configuration.

FlakeHeaven

flakeheaven is a python linter built around flake8 to enable inheritable and complex toml configuration.

This project is a fork of FlakeHell. FlakeHell and other forks of it such as flakehell/flakehell are no longer maintained and do not work with Flake8 4.0.x.

FlakeHeaven works with Flake8 4.0.1 or greater. This fork will be maintained by the community that developed the existing forks.

• Lint md, rst, ipynb, and more.
• Shareable and remote configs.
• Legacy-friendly: ability to get report only about new errors.
• Caching for much better performance.
• Use only specified plugins, not everything installed.
• Make output beautiful.
• pyproject.toml support.
• Check that all required plugins are installed.
• Syntax highlighting in messages and code snippets.
• PyLint integration.
• Powerful GitLab support.
• Codes management:
  • Manage codes per plugin.
  • Enable and disable plugins and codes by wildcard.
  • Show codes for installed plugins.
  • Show all messages and codes for a plugin.
  • Allow codes intersection for different plugins.

Compatibility

FlakeHeaven supports all flake8 plugins, formatters, and configs. However, FlakeHeaven has its own beautiful way to configure enabled plugins and codes. So, options like --ignore and --select are unsupported. You can have flake8 and FlakeHeaven in one project if you want but enabled plugins should be explicitly specified.

Installation

python3 -m pip install --user flakeheaven

Usage

First of all, let's create pyproject.toml config:

[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 = ["-*"]

Show plugins that aren't installed yet:

flakeheaven missed

Show installed plugins, used plugins, specified rules, codes prefixes:

flakeheaven plugins

Show codes and messages for a specific plugin:

flakeheaven codes pyflakes

Run flake8 against the code:

flakeheaven lint

This command accepts all the same arguments as Flake8.

Read the documentation for more information.

Contributing

1. Add tests when possible (eg for features / fixes / refactor, etc. )
2. Add your contribution to the code / docs
3. Ensure your code passes all (both original and your own) tests.
4. Commit using proper header
5. Create a PR

Contributions are welcome! A few ideas where you can contribute:

• Improve documentation.
• Add more tests.
• Improve performance.
• Found a bug? Fix it!
• Made an article about FlakeHeaven? Great! Let's add it into the README.md.
• Don't have time to code? No worries! Just tell your friends and subscribers about the project. More users -> more contributors -> more cool features.

A convenient way to run tests is using Poetry:

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

Thank you ❤️

The FlakeHeaven mascot (Flaky) is created by @illustrator.way and licensed under the CC BY-SA 4.0 license.