[REQUEST] Make use of pre-commit for running linters

[ssbarnea]

I would like to suggest using pre-commit tool (not hook!) for orchestrating linters during development. Currently rich has two linters: black and mypy*.

How would you improve Rich?

It would be much easier to run linting, much easier to enable additional checks (like newline consistency) and make is extremely easy to bump linters.

Projects like black, tox, pytest are already using it for a good number of years.

What problem does it solved for you?

It would make easier to test code locally before making a PR.

If you do not have anything against it, I can easily make a PR to demonstrate it (probably less than 5min to do it).

[willmcgugan]

I'm willing to give it a try. I think @hedythedev found some issues with pre-commit, but as long as its optional I don't see a problem.

[ssbarnea]

I am quite curious which issues @hedythedev identified. I even made a pre-commit presentation back in March around how it works.

[hedyhli]

I had trouble with installing the hook itself, but will try again when I have the time. It uses --user installs which wasn't possible in my environment. However I think it's a good idea overall

[ssbarnea]

While I used pre-commit myself for probable more than 3 years, I almost never use its hook feature. I prefer to be able to bypass it and I got a habbit of running it manually.

I even have alias pc='pre-commit run -a' in my shell. The real value is not the hook, but how easy it makes to manage the lifecycle of the linters (add new, upgrade, run, avoid taking too much disk space, isolate/contain). If curious about a more heavy use of it, take a look at https://github.com/ansible-community/molecule/blob/master/.pre-commit-config.yaml

[Edward-Knight]

It might also be useful to add some of the built-in pre-commit checks as well (like end-of-file-fixer or trailing-whitespace)

[ssbarnea]

I did not want to pollute the original PR with new checks but my plan was to do it in follow-ups, so we can keep them small and easy to review.

[henryiii]

This might be helpful; in Scikit-HEP we are using pre-commit everywhere. https://scikit-hep.org/developer/style. Also you can use https://pre-commit.ci if you want.