|
4 | 4 | [](https://packagist.org/packages/jbzoo/composer-diff/) [](https://packagist.org/packages/jbzoo/composer-diff/stats) [](https://packagist.org/packages/jbzoo/composer-diff/dependents?order_by=downloads) [](https://github.com/JBZoo/Composer-Diff/blob/master/LICENSE)
|
5 | 5 |
|
6 | 6 |
|
| 7 | +<!--ts--> |
| 8 | + * [Why?](#why) |
| 9 | + * [Installation](#installation) |
| 10 | + * [Usage](#usage) |
| 11 | + * [Help Description](#help-description) |
| 12 | + * [Output Examples](#output-examples) |
| 13 | + * [Default view (--output=console)](#default-view---outputconsole) |
| 14 | + * [Markdown Output (--output=markdown)](#markdown-output---outputmarkdown) |
| 15 | + * [JSON Output (--output=json)](#json-output---outputjson) |
| 16 | + * [Roadmap](#roadmap) |
| 17 | + * [Unit tests and check code style](#unit-tests-and-check-code-style) |
| 18 | + * [License](#license) |
| 19 | + * [See Also](#see-also) |
| 20 | +<!--te--> |
| 21 | + |
| 22 | + |
| 23 | +## Why? |
7 | 24 |
|
8 | 25 | See what packages have been changed after you run `composer update` by comparing `composer.lock` to the `git show HEAD:composer.lock`.
|
9 | 26 |
|
@@ -45,30 +62,36 @@ Usage:
|
45 | 62 | diff [options]
|
46 | 63 |
|
47 | 64 | Options:
|
48 |
| - --source=SOURCE The file, git ref, or git ref with filename to compare FROM [default: "HEAD:composer.lock"] |
49 |
| - --target=TARGET The file, git ref, or git ref with filename to compare TO [default: "./composer.lock"] |
50 |
| - --env=ENV Show only selected environment. Available options: both, require, require-dev [default: "both"] |
51 |
| - --output=OUTPUT Output format. Available options: console, markdown, json [default: "console"] |
52 |
| - --no-links Hide all links in tables |
53 |
| - --strict Return exit code if you have any difference |
54 |
| - --no-progress Disable progress bar animation for logs |
55 |
| - --mute-errors Mute any sort of errors. So exit code will be always "0" (if it's possible). |
56 |
| - It has major priority then --non-zero-on-error. It's on your own risk! |
57 |
| - --stdout-only For any errors messages application will use StdOut instead of StdErr. It's on your own risk! |
58 |
| - --non-zero-on-error None-zero exit code on any StdErr message |
59 |
| - --timestamp Show timestamp at the beginning of each message |
60 |
| - --profile Display timing and memory usage information |
61 |
| - --cron Shortcut for crontab. It's basically focused on logs output. It's combination of --timestamp --profile --stdout-only --no-progress -vv |
62 |
| - -h, --help Display help for the given command. When no command is given display help for the diff command |
63 |
| - -q, --quiet Do not output any message |
64 |
| - -V, --version Display this application version |
65 |
| - --ansi|--no-ansi Force (or disable --no-ansi) ANSI output |
66 |
| - -n, --no-interaction Do not ask any interactive question |
67 |
| - -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug |
| 65 | + --source=SOURCE The file, git ref, or git ref with filename to compare FROM [default: "HEAD:composer.lock"] |
| 66 | + --target=TARGET The file, git ref, or git ref with filename to compare TO [default: "./composer.lock"] |
| 67 | + --env=ENV Show only selected environment. Available options: both, require, require-dev [default: "both"] |
| 68 | + --output=OUTPUT Output format. Available options: console, markdown, json [default: "console"] |
| 69 | + --no-links Hide all links in tables |
| 70 | + --strict Return exit code if you have any difference |
| 71 | + --no-progress Disable progress bar animation for logs. It will be used only for text output format. |
| 72 | + --mute-errors Mute any sort of errors. So exit code will be always "0" (if it's possible). |
| 73 | + It has major priority then --non-zero-on-error. It's on your own risk! |
| 74 | + --stdout-only For any errors messages application will use StdOut instead of StdErr. It's on your own risk! |
| 75 | + --non-zero-on-error None-zero exit code on any StdErr message. |
| 76 | + --timestamp Show timestamp at the beginning of each message.It will be used only for text output format. |
| 77 | + --profile Display timing and memory usage information. |
| 78 | + --output-mode=OUTPUT-MODE Output format. Available options: |
| 79 | + text - Default text output format, userfriendly and easy to read. |
| 80 | + cron - Shortcut for crontab. It's basically focused on human-readable logs output. |
| 81 | + It's combination of --timestamp --profile --stdout-only --no-progress -vv. |
| 82 | + logstash - Logstash output format, for integration with ELK stack. |
| 83 | + [default: "text"] |
| 84 | + --cron Alias for --output-mode=cron. Deprecated! |
| 85 | + -h, --help Display help for the given command. When no command is given display help for the diff command |
| 86 | + -q, --quiet Do not output any message |
| 87 | + -V, --version Display this application version |
| 88 | + --ansi|--no-ansi Force (or disable --no-ansi) ANSI output |
| 89 | + -n, --no-interaction Do not ask any interactive question |
| 90 | + -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug |
68 | 91 | ```
|
69 | 92 |
|
70 | 93 |
|
71 |
| -# Output Examples |
| 94 | +## Output Examples |
72 | 95 |
|
73 | 96 | ### Default view (--output=console)
|
74 | 97 |
|
@@ -199,10 +222,8 @@ make build
|
199 | 222 | make test-all
|
200 | 223 | ```
|
201 | 224 |
|
202 |
| -### PS |
203 |
| -Special thanks to the project [davidrjonas/composer-lock-diff](https://github.com/davidrjonas/composer-lock-diff) which inspired me to make a great utility :) |
204 | 225 |
|
205 |
| -### License |
| 226 | +## License |
206 | 227 |
|
207 | 228 | MIT
|
208 | 229 |
|
|
217 | 238 | - [Data](https://github.com/JBZoo/Data) - Extended implementation of ArrayObject. Use files as config/array.
|
218 | 239 | - [Retry](https://github.com/JBZoo/Retry) - Tiny PHP library providing retry/backoff functionality with multiple backoff strategies and jitter support.
|
219 | 240 | - [SimpleTypes](https://github.com/JBZoo/SimpleTypes) - Converting any values and measures - money, weight, exchange rates, length, ...
|
| 241 | + |
| 242 | +Special thanks to the project [davidrjonas/composer-lock-diff](https://github.com/davidrjonas/composer-lock-diff) which inspired me to make a great utility :) |
0 commit comments