在日常的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項目中使用它！
? 版權聲明
文章版權歸作者所有，未經允許請勿轉載。
THE END
