Add documentation for global git hooks support

Author: BrainMaestro

README.md

@@ -5,33 +5,51 @@
 [![Packagist][badge-packagist]][link-packagist]
 [![Download][badge-downloads]][link-packagist]
 
-> Manage git hooks easily in your composer configuration. This package makes it easy to implement a consistent project-wide usage of git hooks. Specifying hooks in the composer file makes them available for every member of the project team. This provides a consistent environment and behavior for everyone which is great.
+> Manage git hooks easily in your composer configuration. This command line tool makes it easy to implement a consistent project-wide usage of git hooks. Specifying hooks in the composer file makes them available for every member of the project team. This provides a consistent environment and behavior for everyone which is great. It is also possible to use to manage git hooks globally for every repository on your computer. That way you have a reliable set of hooks crafted by yourself for every project you choose to work on.
 
 ## Install
 
 Add a `hooks` section to the `extra` section of your `composer.json` and add the hooks there. The previous way of adding hooks to the `scripts` section of your `composer.json` is still supported, but this way is cleaner if you have many scripts.
 
-```json
+```javascript
 {
     "extra": {
         "hooks": {
-            "pre-commit": "phpunit",
-            "post-commit": "echo committed",
-            "pre-push": ["phpunit", "echo pushing!"],
+            "pre-commit": [
+                "echo committing as $(git config user.name)",
+                "php-cs-fixer fix ." // fix style
+            ],
+            // verify commit message. ex: ABC-123: Fix everything
+            "commit-msg": "grep -q '[A-Z]+-[0-9]+.*' $1",
+            "pre-push": [
+                "php-cs-fixer fix --dry-run ." // check style
+                "phpunit"
+            ],
+            "post-merge": "composer update"
             "...": "..."
         }
     }
 }
 ```
 
-Then install the library with
+Then install with
 
 ```sh
 composer require --dev brainmaestro/composer-git-hooks
 ```
 
 This installs the `cghooks` binary to your `vendor/bin` folder. If this folder is not in your path, you will need to preface every command with `vendor/bin/`.
 
+### Global support
+
+You can also install it globally. This feels much more natural when `cghooks` is used with the newly added support for managing global git hooks.
+
+```sh
+composer global require --dev brainmaestro/composer-git-hooks
+```
+
+All commands have global support (besides testing the hooks. Still requires being in the directory with the `composer.json` file).
+
 ### Optional Configuration
 
 #### Shortcut
@@ -63,7 +81,7 @@ Add the following events to your `composer.json` file. The `cghooks` commands wi
 
 ## Usage
 
-All the following commands have to be run in the same folder as your `composer.json` file.
+All the following commands have to be run either in the same folder as your `composer.json` file or by specifying the `--git-dir` option to point to a folder with a `composer.json` file.
 
 ### Adding Hooks
 
@@ -78,10 +96,14 @@ to add all the valid git hooks that have been specified in the composer config.
 
 The `lock` file contains a list of all added hooks.
 
+If the `--global` flag is used, the hooks will be added globally, and the global git config will also be modified. If no directory is provided, there is a fallback to the current `core.hooksPath` in the global config. If that value is not set, it defaults to `$COMPOSER_HOME` (this specific fallback only happens for the `add` command). It will fail with an error if there is still no path after the fallbacks.
+
 ### Updating Hooks
 
 The update command which is run with `cghooks update` basically ignores the lock file and tries to add hooks from the composer lock. This is similar to what the `--force` option for the `add` command did. This command is useful if the hooks in the `composer.json` file have changed since the first time the hooks were added.
 
+This works similarly when used with `--global` except that there is no fallback to `$COMPOSER_HOME` if no directory is provided.
+
 ### Removing Hooks
 
 Hooks can be easily removed with `cghooks remove`. This will remove all the hooks that were specified in the composer config.
@@ -94,6 +116,8 @@ Hooks can also be removed by passing them as arguments. The command `cghooks rem
 
 **CAREFUL**: If the lock file was tampered with or the force option was used, hooks that already existed before using this package, but were specified in the composer scripts config will be removed as well. That is, if you had a previous `pre-commit` hook, but your current composer config also has a `pre-commit` hook, this option will cause the command to remove your initial hook.
 
+This also does not have a fallback to `$COMPOSER_HOME` if no directory is provided when used with `--global`.
+
 ### Listing hooks
 
 Hooks can be listed with the `cghooks list-hooks` command. This basically checks composer config and list the hooks that actually have files.
@@ -102,9 +126,12 @@ Hooks can be listed with the `cghooks list-hooks` command. This basically checks
 
 The following options are common to all commands.
 
-| Option    | Description           | Command                                        |
-| --------- | --------------------- | ---------------------------------------------- |
-| `git-dir` | Path to git directory | `cghooks ${command} --git-dir='/path/to/.git'` |
+| Option    | Description                         | Command                                        |
+| --------- | ----------------------------------- | ---------------------------------------------- |
+| `git-dir` | Path to git directory               | `cghooks ${command} --git-dir='/path/to/.git'` |
+| `global`  | Runs the specified command globally | `cghooks ${command} --global`                  |
+
+Each command also has a flag `-v` to control verbosity for more detailed logs. Currently, only one level is supported.
 
 ### Testing Hooks
 

cghooks

@@ -22,7 +22,7 @@ use BrainMaestro\GitHooks\Commands\ListCommand;
 use BrainMaestro\GitHooks\Commands\HookCommand;
 use Symfony\Component\Console\Application;
 
-$application = new Application('Composer Git Hooks', '2.4.5');
+$application = new Application('Composer Git Hooks', '2.5.0');
 
 $application->add(new AddCommand());
 $application->add(new UpdateCommand());

composer.json

@@ -51,7 +51,13 @@
             "pre-commit": "composer check-style",
             "pre-push": [
                 "composer test",
-                "grep -q $(git tag --sort=-v:refname | head -n 1) cghooks"
+                "appver=$(grep -o -P '\\d.\\d.\\d' cghooks)",
+                "tag=$(git tag --sort=-v:refname | head -n 1 | tr -d v)",
+                "if [ \"$tag\" != \"$appver\" ]; then",
+                "echo \"The most recent tag v$tag does not match the application version $appver\n\"",
+                "sed -i -E \"s/$appver/$tag/\" cghooks",
+                "exit 1",
+                "fi"
             ]
         }
     }

tests/helpersTest.php

@@ -2,9 +2,9 @@
 
 namespace BrainMaestro\GitHooks\Tests;
 
-use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\TestCase as PHPUnitTestCase;
 
-class HelpersTest extends TestCase
+class HelpersTest extends PHPUnitTestCase
 {
     /**
      * @test