Dev: Add pre-commit.com framework hooks #7176
Conversation
|
ping @Zen-CODE, here's the conservative version. |
.pre-commit-config.yaml
Outdated
| - repo: https://github.com/Lucas-C/pre-commit-hooks | ||
| rev: v1.1.7 | ||
| hooks: | ||
| - id: forbid-crlf |
There was a problem hiding this comment.
How does this work on Windows where git will auto convert crlf to lf before committing? Would it cause a error?
There was a problem hiding this comment.
None of my mates at work that are on windows have complained but I'll fire up a VM and doublecheck this personally. That'll probably happen tomorrow though (or maybe much later tonight is I can't sleep or something).
I'm pretty sure the lf<->crlf conversion that git does on windows is done in such way that the hook only sees the actual content going to repo (which would have been converted back to lf)
There was a problem hiding this comment.
hmm, this is getting way more complicated than just installing git and python for windows, what kind of env are the windows people actually running for development ?? If they're on WSL or cygwin they probably do not have the CRLF conversion even enabled if not how do they even enable the pre-commit hooks (ie where do they get make from, for example...)
Anyway gits own documentation says the conversion is done before committing and the hook sees the to-be-committed content so this shoud be transparent.
There was a problem hiding this comment.
Personally I use msys and I set autocrlf=input.
matham
changed the title
* Add pre-commit hooks for basic standards conformity checking * These should not be marked as executable * These lack shebangs so marking them executable did not do anyone any good * add pre-commit to dev requirements * use pre-commit framework for the hook * Move the pre-commit config outside of root As discusses in kivy#7176 (comment) * Document that pre-commit is used and how to skip checks if needed * Mark the old hook script as deprecated
For some basic good practises, see the framework for more info but TLDR is that it handles passing
only files that are in the commit to the hooks and it's very easy to manage hooks.
Fixed some executable flags while at it but all the whitespace normalizations and other changes that the hooks will do automatically will wait for whenever someone actually touches code so that we don't have a giant commit doing only those (as discussed in #7170 )