Download the PHP package davidrjonas/composer-lock-diff without Composer

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

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

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

Options

• --path, -p: Base to with which to prefix paths. Default "./"
• --from: The file^, git ref, or git ref with filename to compare from (HEAD:composer.lock)
• --to: The file^, git ref, or git ref with filename to compare to (composer.lock)
• --md: Markdown table output
• --json: json output
• --pretty: pretty output when combined with --json (>=5.4 only)
• --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 auto-detect from path

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

Example Plain Text Table Output

Markdown Table

Raw

Rendered

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,

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

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.

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,

• https://github.com/delamart
• https://github.com/prometheas
• https://github.com/paxal
• https://github.com/nclavaud
• https://github.com/cafferata
• https://github.com/ihor-sviziev
• https://github.com/wiese
• https://github.com/jibran
• https://github.com/soleuu
• https://github.com/stof