GispoCoding / cookiecutter-qgis-plugin

A QGIS Plugin template to be set up with Cookiecutter
MIT License
24 stars 4 forks source link

More flake8 plugins #29

Closed Joonalai closed 8 months ago

Joonalai commented 3 years ago

Expected behaviour The development of the new plugin should be as easy as possible. Some of this can be achieved with a good set of Flake8 plugins.

Current behaviour There are few plugins, but there could always be more...

Additional context Here is a list of some of the useful plugins:

Joonalai commented 3 years ago

@LKajan, what do you think?

LKajan commented 3 years ago

We sure can add some more flake8 checks. I don't think the overhead of flake8 plugins is too much. I would still consider if the plugin is more just a personal preference or if it really helps to write better quality code.

From the proposed list of plugins I might question the usefullness of tidy-imports and maybe pie. And would probably add flake8-builtins, flake8-mutable, flake8-docstrings.

Here's a nice list of plugins that might be useful https://github.com/DmytroLitvinov/awesome-flake8-extensions. All the proposed plugins are on the list.

Maybe we could add a parameter to cookiecutter generation "Add code quality checks [Recommended, Minimal, None]".

Joonalai commented 3 years ago

Great idea! What do you propose to be included on each level of quality checks?