在日常的PHP项目开发中，我们经常使用Composer来管理项目的依赖关系。执行composer update命令后，composer.lock文件会被更新，记录了当前项目所依赖的确切版本。然而，手动对比更新前后的composer.lock文件，以了解哪些依赖包发生了变化，实在是一件耗时且容易出错的事情。
幸运的是，davidrjonas/composer-lock-diff这个composer插件可以帮助我们轻松解决这个问题。它能够自动比较composer.lock文件与git head（或其他指定版本）的差异，清晰地展示哪些依赖包被更新、新增或移除。
安装
首先，你需要全局安装这个插件：
composer global require davidrjonas/composer-lock-diff:^1.0
安装完成后，确保~/.composer/vendor/bin目录已经添加到你的$PATH环境变量中。如果安装后无法找到composer-lock-diff命令，请检查你的$PATH设置。
使用
安装完成后，使用起来非常简单：
composer update # 不要立即提交！ composer-lock-diff
或者，如果你在使用Vim，可以直接将输出插入到提交信息中：:r!composer-lock-diff。
常用选项
-
-h, --help: 显示帮助信息 -
-p, --path: 指定项目路径，默认为./ -
--from: 指定比较的起始文件、Git ref或带有文件名的Git ref (例如:HEAD:composer.lock) -
--to: 指定比较的目标文件、Git ref或带有文件名的Git ref (例如:composer.lock) -
--json: 以JSON格式输出 -
--pretty: 格式化JSON输出 (PHP >= 5.4.0) -
--md: 使用Markdown格式输出 -
--no-links: 不包含链接 -
--only-prod: 只包含packages中的变更 -
--only-dev: 只包含packages-dev中的变更 -
--vcs: 强制指定版本控制系统 (git, svn, ...)。默认自动检测
示例输出
以下是纯文本表格的示例输出：
+--------------------+-------+--------+------------------------------------------------------------------+ | Production Changes | From | To | Compare | +--------------------+-------+--------+------------------------------------------------------------------+ | guzzlehttp/guzzle | 6.2.0 | 6.3.0 | https://github.com/guzzle/guzzle/compare/6.2.0...6.3.0 | | hashids/hashids | 2.0.0 | 2.0.4 | https://github.com/ivanakimov/hashids.php/compare/2.0.0...2.0.4 | | league/flysystem | 1.0.0 | 1.0.42 | https://github.com/thephpleague/flysystem/compare/1.0.0...1.0.42 | | monolog/monolog | NEW | 1.21.0 | | +--------------------+-------+--------+------------------------------------------------------------------+ +------------------+--------+---------+---------+ | Dev Changes | From | To | Compare | +------------------+--------+---------+---------+ | phpspec/php-diff | v1.0.2 | REMOVED | | +------------------+--------+---------+---------+
优势与应用
-
节省时间: 自动对比，无需手动分析
composer.lock文件。 - 减少错误: 避免手动对比可能造成的疏漏。
- 清晰易懂: 以表格或JSON/Markdown格式展示变更，方便理解。
- 版本控制友好: 方便在提交代码前查看依赖变更，确保提交信息的准确性。
- 灵活配置: 提供多种选项，满足不同的需求。
davidrjonas/composer-lock-diff是一个非常实用的Composer插件，可以帮助开发者更高效地管理项目依赖，避免手动对比的繁琐和错误。强烈推荐在你的PHP项目中使用它！
