| description | title | layout | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Uncover Flake8, a versatile Python linter for code style and error checking. Flake 8 checks against PEP 8 and more, with plugin support for broader analysis. |
Trunk | How to run Flake8 |
|
Flake8 is a linter for Python.
You can enable the Flake8 linter with:
trunk check enable flake8
Flake8 will be auto-enabled if a .flake8 config file is present.
Flake8 supports the following config files:
.flake8
You can move these files to .trunk/configs and trunk check will still find them. See Moving Linters for more info.
Trunk Code Quality provides a default .flake8 if your project does not already have one.
Flake8 has a plugin architecture where if you install a plugin, it gets used. You can enable Flake8 plugins via:
enabled:
- [email protected]:
packages:
- [email protected]flake8-bugbear is probably the most popular flake8 plugin, we recommend it!. Here are a few other popular flake8 plugins you should consider.
-
flake8-comprehensions: Helps in identifying unnecessary comprehensions in your code.
-
flake8-docstrings: Checks for compliance with Python docstring conventions.
-
flake8-import-order: Checks the order of your imports according to various configurable ordering styles.
Here's an updated code snippet with the above Plugins enabled:
enabled:
- [email protected]:
packages:
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- Flake8 site
- Flake8 Trunk Code Quality integration source
- Trunk Code Quality's open source plugins repo