Add example configuration to class PHPDoc

Author: sebastianfeldmann

src/Hook/Condition/Config/CustomValueIsTruthy.php

@@ -21,13 +21,17 @@
  *
  * Example configuration:
  *
- * "action": "some-action"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\Config\\CustomValueIsTruthy",
- *    "args": [
- *      "NAME_OF_CUSTOM_VALUE"
- *    ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.Config.CustomValueIsTruthy",
+ *       "args": ["NAME_OF_CUSTOM_VALUE"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Hook/Condition/FileChanged/All.php

@@ -21,6 +21,22 @@
  * The FileChange condition is applicable for `post-merge` and `post-checkout` hooks.
  * It checks if all configured files are updated within the last change set.
  *
+ * Example configuration:
+ *
+ *  <code>
+ *  {
+ *    "action": "some-action"
+ *    "conditions": [
+ *      {
+ *        "exec": "CaptainHook.FileChanged.All",
+ *        "args": [
+ *          ["list", "of", "files"]
+ *        ]
+ *      }
+ *    ]
+ *  }
+ *  </code>
+ *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>
  * @link    https://github.com/captainhook-git/captainhook

src/Hook/Condition/FileChanged/Any.php

@@ -19,21 +19,24 @@
  * Class Any
  *
  * The FileChange condition is applicable for `post-merge` and `post-checkout` hooks.
- * For example it can be used to trigger an automatic composer install if the composer.json
- * or composer.lock file is changed during a checkout or merge.
+ * For example, it can be used to trigger an automatic composer install if the composer.json
+ * or `composer.lock` file is changed during a checkout or merge.
  *
  * Example configuration:
  *
- * "action": "composer install"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChange\\Any",
- *    "args": [
- *      [
- *        "composer.json",
- *        "composer.lock"
- *      ]
- *    ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileChanged.Any",
+ *       "args": [
+ *         ["list", "of", "files"]
+ *       ]
+ *     }
+ *   ]
+ * }
+ *  </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Hook/Condition/FileChanged/OfType.php

@@ -25,13 +25,17 @@
  *
  * Example configuration:
  *
- * "action": "some-action"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\OfType",
- *    "args": [
- *      "php"
- *    ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileChanged.OfType",
+ *       "args": ["php"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Hook/Condition/FileStaged/All.php

@@ -23,13 +23,19 @@
  *
  * Example configuration:
  *
- *  "action": "some-action"
- *  "conditions": [
- *    {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\All",
- *     "args": [
- *       ["file1", "file2", "file3"]
- *    ]}
- *  ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileStaged.All",
+ *       "args": [
+ *         ["list", "of", "files"]
+ *       ]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * The file list can also be defined as comma seperated string "file1,file2,file3"
  *

src/Hook/Condition/FileStaged/Any.php

@@ -20,15 +20,21 @@
  *
  * The FileStaged condition is applicable for `pre-commit hooks.
  *
- *  Example configuration:
+ * Example configuration:
  *
+ * <code>
+ * {
  *   "action": "some-action"
  *   "conditions": [
- *     {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\Any",
- *      "args": [
- *        ["file1", "file2", "file3"]
- *     ]}
+ *     {
+ *       "exec": "CaptainHook.FileStaged.Any",
+ *       "args": [
+ *         ["list", "of", "files"]
+ *       ]
+ *     }
  *   ]
+ * }
+ * </code>
  *
  *  The file list can also be defined as comma seperated string "file1,file2,file3"
  *

src/Hook/Condition/FileStaged/InDirectory.php

@@ -26,13 +26,17 @@
  *
  * Example configuration:
  *
- * "action": "some-action"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\InDirectory",
- *    "args": [
- *      "src/"
- *   ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileStaged.InDirectory",
+ *       "args": ["src"]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Hook/Condition/FileStaged/OfType.php

@@ -27,18 +27,24 @@
  *
  * Example configuration:
  *
- * "action": "some-action"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
- *    "args": [
- *      "php",
- *      ["A", "C"]
- *    ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileStaged.OfType",
+ *       "args": [
+ *         "php",
+ *         ["A", "C"]
+ *       ]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * Multiple types can be configured using a comma separated string or an array
- * "php,html,xml"
- * ["php", "html", "xml"]
+ *  - "php,html,xml"
+ *  - ["php", "html", "xml"]
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Hook/Condition/FileStaged/ThatIs.php

@@ -26,13 +26,19 @@
  *
  * Example configuration:
  *
- * "action": "some-action"
- * "conditions": [
- *   {"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\ThatIs",
- *    "args": [
- *      {"ofType": "php", "inDirectory": "foo/", "diff-filter": ["A", "C"]}
- *    ]}
- * ]
+ * <code>
+ * {
+ *   "action": "some-action"
+ *   "conditions": [
+ *     {
+ *       "exec": "CaptainHook.FileStaged.ThatIs",
+ *       "args": [
+ *         {"ofType": "php", "inDirectory": "foo/", "diff-filter": ["A", "C"]}
+ *       ]
+ *     }
+ *   ]
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <[email protected]>

src/Runner/Shorthand.php

@@ -12,7 +12,6 @@
 namespace CaptainHook\App\Runner;
 
 use CaptainHook\App\Hook;
-use PHPUnit\Framework\MockObject\MockObject;
 use RuntimeException;
 
 /**
@@ -62,7 +61,7 @@ class Shorthand
             ],
         ],
         'condition' => [
-            'inconfig'    => [
+            'config'    => [
                 'customvalueistruthy' => Hook\Condition\Config\CustomValueIsTruthy::class,
                 'customvalueisfalsy'  => Hook\Condition\Config\CustomValueIsFalsy::class,
             ],
@@ -71,9 +70,11 @@ class Shorthand
                 'all' => Hook\Condition\FileChanged\All::class,
             ],
             'filestaged'  => [
-                'all'    => Hook\Condition\FileStaged\All::class,
-                'any'    => Hook\Condition\FileStaged\Any::class,
-                'thatis' => Hook\Condition\FileStaged\ThatIs::class,
+                'all'         => Hook\Condition\FileStaged\All::class,
+                'any'         => Hook\Condition\FileStaged\Any::class,
+                'indirectory' => Hook\Condition\FileStaged\InDirectory::class,
+                'oftype'      => Hook\Condition\FileStaged\OfType::class,
+                'thatis'      => Hook\Condition\FileStaged\ThatIs::class,
             ],
             'status'      => [
                 'onbranch'            => Hook\Condition\Branch\On::class,