Add pre-commit hooks for coding standards

[PelagicGames]

If we want athlib to form a standard, we should write high-quality code:

• PEP8 for Python
• Some kind of linter for javascript

[mullet1989]

I have been working on a js version of this library albeit on my own profile for now (a little bit) https://github.com/mullet1989/athlibjs. I am using eslint which I believe to be a good tool so long as the config is sound.

[captainrobbo]

I was planning to play with something like this on the JS side: https://dev.to/corgibytes/setting-up-a-minimal-yet-useful-javascript-dev-environment
But I'm not fussed what we use and would prefer someone who knows the JS ecosystem sets up something to follow.
For Python, something like this maybe: https://github.com/cbrueffer/pep8-git-hook

[PelagicGames]

What would be ideal is a pre-receive hook running on GitHub, but that requires GitHub enterprise (or a private Git server).

Instead, I'll add a pre-push hook to a hooks directory, plus a script to git config --set core.hooksPath $GIT_DIR/../hooks. This will have to be run manually by users of the repository (once only), so we might want to wrap it up in a more general setup script to be run by any contributors to athlib.

Note that the use of a non-standard hooksPath is only supported from Git 2.9 onward (I had to upgrade to 2.10 from 2.5 on my Mac).

[PelagicGames]

An alternative would be to put it in setup.py, to be run before uploading to PyPI, or perhaps best to do both.

I'll see where I can get to tonight (didn't get home until late this morning after an electrical failure on my train home meant the doors wouldn't open).

[captainrobbo]

I'm happy to test any of these things tonight. I'm trying to get my work Ubuntu box to tell me what the hooksPath is, but none seems to be set. Default on Ubuntu is 1.9.1. If older Git supports hooks, we can just provide some instructions on where one needs to copy the script to. The handful of developers on this are all able to follow instructions once set up. - Andy

…

On 19 January 2017 at 15:31, Bilen Ahmet ***@***.***> wrote: An alternative would be to put it in setup.py, to be run before uploading to PyPI, or perhaps best to do both. I'll see where I can get to tonight (didn't get home until late this morning after an electrical failure on my train home meant the doors wouldn't open). — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#14 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AKsO5qpKLEbTmq8QjdI3W73hIN1CgOEJks5rT4HUgaJpZM4LJSQ3> .

[PelagicGames]

I've just realised I'm being stupid, and we can just do with copying the contents of the hooks directory, rather than modifying hooksPath.

…

On 19 Jan 2017 16:02, "Andy Robinson" ***@***.***> wrote: I'm happy to test any of these things tonight. I'm trying to get my work Ubuntu box to tell me what the hooksPath is, but none seems to be set. Default on Ubuntu is 1.9.1. If older Git supports hooks, we can just provide some instructions on where one needs to copy the script to. The handful of developers on this are all able to follow instructions once set up. - Andy On 19 January 2017 at 15:31, Bilen Ahmet ***@***.***> wrote: > An alternative would be to put it in setup.py, to be run before uploading > to PyPI, or perhaps best to do both. > > I'll see where I can get to tonight (didn't get home until late this > morning after an electrical failure on my train home meant the doors > wouldn't open). > > — > You are receiving this because you commented. > Reply to this email directly, view it on GitHub > <#14 (comment)>, or mute > the thread > <https://github.com/notifications/unsubscribe-auth/ AKsO5qpKLEbTmq8QjdI3W73hIN1CgOEJks5rT4HUgaJpZM4LJSQ3> > . > — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#14 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEjkutgArhA2wGHedgh8t-pUcq0J9vxnks5rT4kSgaJpZM4LJSQ3> .

[captainrobbo]

Bilen, I think I cracked it. By the way, Guido wanted the pep8 script to be renamed to pycodestyle
Step 1: pip install pycodestyle

Step 2: in .git/hooks, create a file with executable permissions thus:
#!/bin/sh
pycodestyle --first --exclude=bin,lib,include,sampledata

Step 3: try a commit. It will be aborted if any bad stuff is found, because pycodestyle returns non-zero exit status if it finds anything.

I'm going to put this in the README later tonight and also push my cleanups.

[PelagicGames]

That seems to have done the job for Python, although I've tweaked it to ignore the docs directory, and fixed up some files that were apparently still failing. Is it worth doing something similar for Javascript now?

…

On Thu, Jan 19, 2017 at 9:46 PM, Andy Robinson ***@***.***> wrote: Bilen, I think I cracked it. By the way, Guido wanted the pep8 script to be renamed to pycodestyle Step 1: pip install pycodestyle Step 2: in .git/hooks, create a file with executable permissions thus: #!/bin/sh pycodestyle --first --exclude=bin,lib,include,sampledata Step 3: try a commit. It will be aborted if any bad stuff is found, because pycodestyle returns non-zero exit status if it finds anything. I'm going to put this in the README later tonight and also push my cleanups. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#14 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEjkumtzHC8ZQ7A4sEi0suVLsHv2n10Zks5rT9nHgaJpZM4LJSQ3> .

-- Bilen Ahmet *Pelagic Games*

[captainrobbo]

On 5 February 2017 at 20:56, Bilen Ahmet ***@***.***> wrote: That seems to have done the job for Python, although I've tweaked it to ignore the docs directory, and fixed up some files that were apparently still failing. Is it worth doing something similar for Javascript now?

I think so. We got a webpack-based workflow working internally and I'll try to get something minimal there in the next couple of nights.