|
10 | 10 | [](https://packagist.org/packages/tm/tooly-composer-script) |
11 | 11 | [](https://gitter.im/tommy-muehle/tooly-composer-script?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
12 | 12 |
|
13 | | -With the tooly [composer-script](https://getcomposer.org/doc/articles/scripts.md) aka hook you can manage needed PHAR files for quality assurance, such as PHPUnit or phpmd, in your project's composer.json. Every PHAR file will be saved in the [composer binary directory](https://getcomposer.org/doc/articles/vendor-binaries.md). |
| 13 | +With tooly [composer-script](https://getcomposer.org/doc/articles/scripts.md) you can version needed PHAR files in your project's composer.json without adding them directly to a VCS, |
| 14 | +* to save disk space |
| 15 | +* to be sure that all developers in your project get the required toolchain |
| 16 | +* to prepare a CI/CD System |
| 17 | +* (optional) to automatically check the [GPG signature verification](https://www.gnupg.org/gph/en/manual/x135.html) for each tool |
14 | 18 |
|
15 | | -So you can be sure that all developers in your project get the required PHAR tools in the needed version with nothing more as composer. Optional with [GPG signature verification](https://www.gnupg.org/gph/en/manual/x135.html) for each tool. |
| 19 | +Every PHAR file will be saved in the [composer binary directory](https://getcomposer.org/doc/articles/vendor-binaries.md). |
16 | 20 |
|
17 | 21 | ## Example |
18 | 22 |
|
19 | | -For an quick example look at the [composer.json](composer.json#L57-L76) here. |
| 23 | +An real example can be found [here](composer.json#L57-L76). |
| 24 | + |
| 25 | +## Requirements |
| 26 | + |
| 27 | +* PHP >= 5.6 |
| 28 | +* Composer |
20 | 29 |
|
21 | 30 | ## Install |
22 | 31 |
|
23 | | -To use the script just do the following single command: |
24 | | - |
25 | | -*Note: There are no further dependencies in this library. Only PHP.* |
| 32 | +To use the script execute the following command: |
26 | 33 |
|
27 | 34 | ``` |
28 | | -composer require tm/tooly-composer-script |
| 35 | +composer require --dev tm/tooly-composer-script |
29 | 36 | ``` |
30 | 37 |
|
31 | 38 | Then add the script in the composer.json under *"scripts"* with the event names you want to trigger. |
@@ -111,6 +118,8 @@ But is also useful if some require-dev library has one of the tools as own requi |
111 | 118 | This parameter means that this phar is only needed in developing mode. |
112 | 119 | So the command ```composer [install|update] --no-dev``` ignores this phar tool. |
113 | 120 |
|
| 121 | +**Note: Therefore tooly must be a [no-dev requirement](https://getcomposer.org/doc/04-schema.md#require)** |
| 122 | + |
114 | 123 | ## Postcardware |
115 | 124 |
|
116 | 125 | You're free to use this package (it's [MIT-licensed](LICENSE)), but if it makes you happy it would be a great pleasure for me if you send a postcard from your hometown to me. |
|
0 commit comments