智慧物流>> composer-lock-diff>> 返回
项目作者： davidrjonas

项目描述 ：
See what has changed after a composer update
高级语言： PHP
项目地址: git://github.com/davidrjonas/composer-lock-diff.git
创建时间： 2016-09-30T06:22:24Z
项目社区：https://github.com/davidrjonas/composer-lock-diff
开源协议：MIT License
下载


composer-lock-diff

See what packages have changed after you run composer update by comparing composer.lock to the the git HEAD.

Requires:

  • php >= 5.3

There are no other dependencies.

Install

  1. composer global require davidrjonas/composer-lock-diff:^1.0
  3. # With zsh, run `rehash` to make it known to the shell.
  5. # try it
  6. composer-lock-diff --help

If composer-lock-diff is not found, make sure ~/.composer/vendor/bin is in
your $PATH env variable. For more information on how to do that see this question on Stack Overflow.

Usage

  1. composer update
  2. # don't commit yet!
  3. composer-lock-diff

Or from vim, to insert the output into the commit message, type :r!composer-lock-diff.

Options

  • -h, --help: Print this message
  • -p, --path: Base to with which to prefix paths. Default “./“
    E.g. -p app would look for HEAD:app/composer.lock and app/composer.lock
  • --from: The file^, git ref, or git ref with filename to compare from (git: HEAD:composer.lock, svn: composer.lock@BASE)
  • --to: The file^, git ref, or git ref with filename to compare to (composer.lock)
  • --json: Format output as JSON
  • --pretty: Pretty print JSON output (PHP >= 5.4.0)
  • --md: Use markdown instead of plain text
  • --no-links: Don’t include Compare links in plain text or any links in markdown
  • --only-prod: Only include changes from packages
  • --only-dev: Only include changes from packages-dev
  • --vcs: Force vcs (git, svn, …). Default: attempt to auto-detect

^ File includes anything available as a protocol stream wrapper such as URLs.

Example Plain Text Table Output

  1. +--------------------+-------+--------+------------------------------------------------------------------+
  2. | Production Changes | From  | To     | Compare                                                          |
  3. +--------------------+-------+--------+------------------------------------------------------------------+
  4. | guzzlehttp/guzzle  | 6.2.0 | 6.3.0  | https://github.com/guzzle/guzzle/compare/6.2.0...6.3.0           |
  5. | hashids/hashids    | 2.0.0 | 2.0.4  | https://github.com/ivanakimov/hashids.php/compare/2.0.0...2.0.4  |
  6. | league/flysystem   | 1.0.0 | 1.0.42 | https://github.com/thephpleague/flysystem/compare/1.0.0...1.0.42 |
  7. | monolog/monolog    | NEW   | 1.21.0 |                                                                  |
  8. +--------------------+-------+--------+------------------------------------------------------------------+
  10. +------------------+--------+---------+---------+
  11. | Dev Changes      | From   | To      | Compare |
  12. +------------------+--------+---------+---------+
  13. | phpspec/php-diff | v1.0.2 | REMOVED |         |
  14. +------------------+--------+---------+---------+

Markdown Table

Raw

  1. | Production Changes | From  | To     | Compare                                                                 |
  2. |--------------------|-------|--------|-------------------------------------------------------------------------|
  3. | guzzlehttp/guzzle  | 6.2.0 | 6.3.0  | [...](https://github.com/guzzle/guzzle/compare/6.2.0...6.3.0)           |
  4. | hashids/hashids    | 2.0.0 | 2.0.4  | [...](https://github.com/ivanakimov/hashids.php/compare/2.0.0...2.0.4)  |
  5. | league/flysystem   | 1.0.0 | 1.0.42 | [...](https://github.com/thephpleague/flysystem/compare/1.0.0...1.0.42) |
  6. | monolog/monolog    | NEW   | 1.21.0 |                                                                         |
  8. | Dev Changes      | From   | To      | Compare |
  9. |------------------|--------|---------|---------|
  10. | phpspec/php-diff | v1.0.2 | REMOVED |         |

Rendered

Production Changes From To Compare
guzzlehttp/guzzle 6.2.0 6.3.0 …
hashids/hashids 2.0.0 2.0.4 …
league/flysystem 1.0.0 1.0.42 …
monolog/monolog NEW 1.21.0
Dev Changes From To Compare
phpspec/php-diff v1.0.2 REMOVED

Development

New features are always welcome! Follow these guidelines

  • Try to match the style of the code that already exists, even if it isn’t your style (sorry!).
  • Make sure there is a way to test the feature.
  • Test with PHP 5.3 (I’m serious!), >=5.4<7, 7.current. Docker is helpful, particularly for the older versions. Just run the ubuntu:12.04 image and install php for 5.3 and 14.04 for 5.6. I can help if you’re having trouble.

The Makefile has some test cases. Run make | less and inspect the output. If you need specific versions or more information, continue reading.

To run using the test data manually simply point the --to and --from args at the lock files,

  1. php ./composer-lock-diff --from ./test-data/composer.from.lock --to ./test-data/composer.to.lock

Docker is very helpful for targeting a specific version of php and/or composer,

  1. docker run --rm -it -v "$PWD":/src -w /src php:7.4.2 \
  2.   php ./composer-lock-diff --from ./test-data/composer.from.lock --to ./test-data/composer.to.lock

Sometimes you want to test the git related functions. To do that first I make a temporary repo. Then I copy into it test-data/composer.from.lock as composer.lock to set the previous state and test-data/composer.to.json as composer.json for the future state. I commit those then run composer-lock-diff with the options I want to test and visually inspect the results.

  1. mkdir tmp && cd tmp
  2. git init
  3. cp ../test-data/composer.to.json composer.json
  4. cp ../test-data/composer.from.lock composer.lock
  5. git add .
  6. git commit -m "initial"
  8. composer update
  9. # or
  10. docker run --rm -it -v "$PWD":/src -w /src composer:latest php composer update
  12. php ../composer-lock-diff
  14. # or, if you want to use docker, you'll need git
  15. cd ..
  16. docker run --rm -it -v "$PWD":/src -w /src php:7.4.2 bash
  17. apt-get update && apt-get install -y git
  18. # You may want composer as well,
  19. curl -OL https://getcomposer.org/download/1.9.3/composer.phar
  20. cd tmp
  21. php ../composer.phar update
  22. php ../composer-lock-diff

Add a test case to test-data/

  • Make a new, temporary git repo in ./tmp
  • Copy ../test-data/composer.from.json as composer.json and ../test-data/composer.from.lock as composer.lock.
  • Commit them.
  • Run composer install
  • Add your pre case to composer.json. Use an exact version.
  • Run composer update.
  • The generated composer.lock should look similar to ../test-data/composer.from.lock but there will be differences due to transient dependencies. No real way around that. Use composer-lock-diff to make sure none of the named packages change versions and your new case is there.
  • Copy composer.json to ../test-data/composer.from.json and composer.lock to composer.from.lock.
  • Copy ../test-data/composer.to.json as composer.json.
  • Add your post case to composer.json. Again, exact versions are best.
  • Generate a new lock file.
  • Use composer-lock-diff to test your feature.
  • When you’re happy with it, copy composer.json to ../test-data/composer.to.json and composer.lock to ../test-data/composer.to.lock.

Test Cases

See Makefile.

  • comopser-lock-diff # no args
  • composer-lock-diff --from ./test-data/composer.from.lock --to ./test-data/composer.to.lock
  • composer-lock-diff --path ./test-data/
  • composer-lock-diff --from <git ref> # this gets tested with ‘no args’
  • composer-lock-diff --from <git ref with filename>
  • composer-lock-diff --to <git ref>
  • composer-lock-diff --to <git ref with filename>
  • composer-lock-diff --only-dev
  • composer-lock-diff --only-prod
  • composer-lock-diff --no-links
  • composer-lock-diff --json
  • composer-lock-diff --json --pretty
  • composer-lock-diff --md
  • composer-lock-diff --md --no-links

If anyone can help test with Windows that would be very much appreciated!

Contributors

Thanks to everyone who has shared ideas and code! In particular,