githooks

1。 wtyd/githooks

還有許多其他用於管理git鉤的工具和作曲家插件。但是Githooks提供：

• 獨立應用。 Githooks是二進制（.phar），因此其依賴關係不會干擾您的應用程序依賴關係。
• 由作曲家管理。您不需要其他工具，例如Phive或其他工具。
• 解決所有質量檢查工具配置（至少所有受支持的工具）。
• 它將開發人員從僅使用githooks tool name-of-the-tool執行的如何執行QA工具來抽象。
• 您還可以創建自己的腳本並配置任何Git Hook。

此外，如果您有混合項目，則可以與JavaScript驗證工具（如Typicode/Husky）一起使用。

2。要求

• php> = 7.1
• 您需要檢查代碼所需的工具。
• 或者您自己的腳本掛鉤。

3。安裝

1。必須像作曲家一樣安裝githooks：

composer require --dev wtyd/githooks

注意：對於php <8.1，您必須將下一個post-update-cmd事件添加到composer.json的scripts部分：

 "scripts" : {
    "post-update-cmd" : [
      " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
    ]
}

然後運行composer update wtyd/githooks 。

在版本2.3.0之前，所使用的方法為php72orminorupdate ，但已棄用，並將從3.0.0版中刪除

將其添加到post-install-cm事件也很方便，以便其餘的項目開發人員沒有構建問題

 "scripts" : {
    "post-update-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions " ,
    "post-install-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
}

2。安裝所有所需的支持工具。如何安裝工具無關緊要。

3。用githooks conf:init初始化githooks。此命令在root路徑（ githooks.yml ）中創建配置文件。

4。運行githooks hook 。它將腳本複制在.git/hooks目錄中的預加入事件中的啟動githooks。您也可以運行githooks hook otherHook MyScriptFile.php以設置使用自定義腳本的任何鉤子。有關更多信息，請參見Wiki。

為了確保它是自動配置的，我們可以在composer.json文件（ scripts部分）的post-update-cmd和post-install-cmd事件中配置命令：

 "scripts" : {
    "post-update-cmd" : [
    " vendor/bin/githooks hook " // or "vendor/bin/githooks hook pre-commit MyScriptFile.php"
    ],
    "post-install-cmd" : [
    " vendor/bin/githooks hook "
    ]
}

5。設置配置文件。

4。用法

提交時，所有配置的代碼檢查工具將自動啟動。如果您的代碼通過所有檢查，則Githooks允許您提交。如果沒有，您必須修復代碼並重試：

您也可以隨時隨地運行Githooks。所有工具同時或一個一個工具：

githooks tool all # Run all tools
githooks tool phpcs # Run only phpcs

5。支持工具

目前，受支持的工具是：

• php codesniffer（PHPC和PHPCBF）
• PHP複製糊劑檢測器
• php雜物探測器
• 平行細小
• PHP Stan
• 本地PHP安全檢查器

但是您可以在任何git鉤上設置自己的腳本。

6。設置配置文件

githooks.yml文件分配在三個部分：

6.1。選項

6.1.1。執行

execution標誌標記了Githooks如何運行：

• full （默認選項）：執行始終針對為每個工具設置的所有路徑設置的所有工具。例如，您將PHPC設置為在src和app Directories中運行。該提交僅包含來自database目錄的修改文件。 PHPC將檢查src和app目錄，即使這些目錄中沒有修改文件。
• fast ：此選項僅針對COMMIT修改的文件運行工具。
  • 此選項僅影響以下工具：phpcs，phpmd，phpstan和Parallel-lint。其餘工具將作為完整選項運行。
  • 警告！ ！ ！您必須在githooks.yml或Eath工具的配置文件中設置工具的排除，因為此選項覆蓋工具的關鍵paths ，以便僅針對修改的文件執行它們。

6.1.2。過程

同時在多個過程中運行多個工具（ tool all命令）。默認的進程數為1。

6.2。工具

這是一個帶有Githooks將運行的工具名稱的數組。工具的名稱是它們的可執行文件。如果您希望執行所有工具， Tools密鑰將如下：

 Tools :
    - phpstan
    - security-checker
    - parallel-lint
    - phpcs
    - phpcbf
    - phpmd
    - phpcpd

工具的順序是執行它們的順序。

6.3。設置工具

在下一步中，您必須配置具有與工具密鑰相同的名稱的工具。例如，對於設置PHPC：

 phpcs :
    executablePath : vendor/bin/phpcs
    paths : [src, tests]
    ignore : [vendor]
    standard : ' PSR12 '

所有可用選項都在Wiki中。

7。貢獻

他人的貢獻將不勝感激！發送拉請請求/問題。在Wiki部分檢查所有步驟以進行貢獻。謝謝！

8.許可

麻省理工學院許可證（麻省理工學院）。請參閱許可證文件以獲取更多信息。