Add branch condition shorthands

Author: sebastianfeldmann

src/Hook/Condition/Branch/NotOn.php

@@ -18,7 +18,20 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * NotOn condition
+ * NotOn Branch condition
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "some-action",
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.Status.NotOnBranch",
+ *       "args": ["not-on-this-branch"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Hook/Condition/Branch/NotOnMatching.php

@@ -18,7 +18,20 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * NotOnMatching condition
+ * NotOnMatching Branch condition
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "some-action",
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.Status.NotOnMatchingBranch",
+ *       "args": ["#^branches-names/not-matching[0-9]+-this-regex$#i"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Hook/Condition/Branch/On.php

@@ -18,7 +18,20 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * On condition
+ * On Branch condition
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "some-action",
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.Status.OnBranch",
+ *       "args": ["only-on-this-branch"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Hook/Condition/Branch/OnMatching.php

@@ -18,7 +18,20 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * OnMatching condition
+ * OnMatching Branch condition
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "some-action",
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.Status.OnMatchingBranch",
+ *       "args": ["#^branches-names/matching[0-9]+-this-regex$#i"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Runner/Shorthand.php

@@ -75,7 +75,10 @@ class Shorthand
                 'thatis' => Hook\Condition\FileStaged\ThatIs::class,
             ],
             'status'      => [
-                'onbranch' => Hook\Condition\Branch\On::class,
+                'onbranch'            => Hook\Condition\Branch\On::class,
+                'onmatchingbranch'    => Hook\Condition\Branch\OnMatching::class,
+                'notonbranch'         => Hook\Condition\Branch\NotOn::class,
+                'notonmatchingbranch' => Hook\Condition\Branch\NotOnMatching::class,
             ]
         ]
     ];