Given enough time everyone seems to develop a collection of shell scripts they go back to over and over -- this is my collection.
Let's assume you're working on a Python project and using Sphinx to generate
documentation. Keeping documentation up-to-date as a code base changes is quite
tedious to do by hand. Two basic ways to automate this task are as follows;
build docs as CI/CD system artifacts or write a script to build docs when a code
base is updated.
This hook takes the latter option -- documentation is re-built whenever commits are made.
Imagine the scenario; you're in a group where someone has discovered pylint
and decided all commits to production need to have score X/10 in order to pass review.
While linting is an extremely import part of refactoring, it can be frustrating when
pylint is used with default settings and a numeric pass/fail criteria is established
that isn't tailored to the needs of particular code base or development team.
Enter the Super Lint-Hammer -- a commit hook that will run autopep8 on every
*.py file in the Git repo. While this won't fix fundamental problems with a code base,
it will make things more compliant with PEP8 standards and usually improve pylint scores
significantly. It can allow code to pass automatic review in a pinch,
and give you enough time to talk to your pedantic co-workers.