CaptainHook是針對 php 開發人員的易於使用且非常靈活的 git hook 函式庫。它使您能夠在簡單的 json 檔案中配置 git hook 操作。
您可以使用CaptainHook來驗證或準備提交訊息、確保程式碼品質或在提交或推送更改到 git 之前執行單元測試。您可以在拉取最新變更後自動清除本機快取或安裝最新的 Composer 相依性。
CaptainHook可以輕鬆地在團隊內共享鉤子,甚至可以確保團隊中的每個人都在本地啟動鉤子。
您可以執行 cli 命令,使用一些內建驗證器,或編寫自己的CaptainHook執行的 PHP 類別。有關更多信息,請查看文檔。
安裝CaptainHook的首選方法是安裝 PHAR 檔案。您可以使用 Phive 或從 GitHub 發布頁面下載 PHAR 來執行此操作。
phive安裝captainhook
或使用Composer來安裝它。
作曲家要求 --dev Captainhook/captainhook-phar
如果您想獲取原始程式碼及其所有依賴項,您可以使用:
作曲家要求 --dev Captainhook/captainhook
安裝 CaptainHook 後,您可以使用Captainhook執行檔來建立設定。
供應商/bin/captainhook 配置
建立Captainhook.json設定檔後,您必須透過將鉤子安裝到本機 .git 目錄來啟動它們。為此,只需執行以下CaptainHook命令。
供應商/bin/captainhook 安裝
觀看這個簡短的安裝影片。
CaptainHook的目標之一是讓團隊輕鬆使用相同的 git hook。如果你想確保每個人都實際安裝了鉤子,你可以使用小型Composer插件hook-installer
。每次執行Composer命令時,它都會執行captainhook install
命令。
作曲家需要 --dev Captainhook/hook-installer
當然,隊友仍然可以在不執行掛鉤的情況下提交,這就是為什麼您也應該在後端運行適當的檢查。但至少這樣沒人會「意外」忘記安裝它們。
以下是Captainhook.json設定檔的範例。
{“commit-msg”:{“啟用”:true,“操作”:[ {「action」:「CaptainHookAppHookMessageActionBeams」} ] }, "預先提交": {"啟用": true,"操作": [ {“行動”:“phpunit”}, {“action”:“phpcs --standard = psr2 src”} ] }, "預先推播": {"啟用": false,"操作": [] } }
那麼您想為CaptainHook
庫做出貢獻嗎?出色的!非常感謝。我絕對需要你的幫助。
查看貢獻指南。