Some Git Hooks

Install, Update, Delete

Install

Call install.sh in hook sub directory, eg:

some/git/repo/dir$ path/to/git-hooks/hook-sub-dir/install.sh

Each install script has a hash code in it, eg:

installHook post-commit "$HOOK_CONTENT" 1l0ebpnpj11s5j5p

The 1l0ebpnpj11s5j5p is hash code, its used when update or delete hook, to identify where to change in hook script.

Notice hook content may have multiple lines written to hook script, if user changed hook content and number of lines changed, run install.sh again may affect wrong number of rows in hook script. In this case, leave more empty lines in hook script, or manual delete then install again.

Delete

You need manual edit hook script(like post-commit), find hook content by hash code of the hook you want, and delete code rows.

Hooks Intro

auto-copyright-year

Auto update copyright year when commit.

Need copyright-year-updater.sh to actual do copyright year change job.

Configs stored in update-copyright-year.php.

auto-last-modified-time

Update Last Modified Time in source code when submit.

Script update-last-modified-time.php can use manually.

Usage: Write a start date like Last Modified: 2017-08-17 in head lines of your code, the script will change it to full format, and update when hook run.

Configs stored in update-last-modified-time.php.

Notice for Mac OSX user:

Need GNU find to work properly, install findutils with brew.

brew install findutils --with-default-names

phpcs

Call PHP Code Sniffer executable to check commit file, prevent commit when fail.

Configs stored in do-phpcs.php.

set-objects-writable

Set all files in .git writable for current user.

Script find-readonly-objects.sh can use manually to find readonly files in .git.

Customize Configuration

As hooks are mostly simple scripts, we use simple config stored in variables. Configurable scripts have their default config in top lines, eg:

// Config
$phpcsPath = '/usr/local/bin/phpcs';
$allowedExt = [
    'php',
];
$codingStandard = 'psr2';
// Other options used by phpcs
$otherOptions = '';

User can create config.php or config.sh in same directory with this script, and assign user config with variable assign like code above, the hook script will auto load user config and overwrite default config.

Notice: Do NOT include #! /usr/bin/env php shebang in head of config.php.

License

Distribute under the MIT License.

fwolf / git-hooks