lefthook

Node.js，Ruby，Python和許多其他類型的項目的Git Hooks經理。

• 快速地。它是在Go中寫的。可以並行運行命令。
• 強大的。它允許控制您傳遞給命令的執行和文件。
• 簡單的。它是無依賴性的二進製文件，可以在任何環境中起作用。

文件

閱讀介紹帖子

安裝

使用GO （> = 1.23）：

go install github.com/evilmartians/lefthook@latest

使用NPM ：

npm install lefthook --save-dev

對於Ruby ：

gem install lefthook

對於Python ：

pip install lefthook

安裝指南具有更多的安裝Lefthook的方法：APT，Brew，Winget等。

用法

配置鉤子，安裝一次，然後忘記它：依靠下面的魔法。

tl; dr

 # Configure your hooks
vim lefthook.yml

# Install them to the git project
lefthook install

# Enjoy your work with git
git add -A && git commit -m ' ... ' 

更多細節

• lefthook.yml配置選項的配置。
• Lefthook CLI選項，支持的ENV和使用技巧的使用。
• 討論問題，想法，建議。

為什麼要Lefthook

• 並行執行

給您更高的速度。文件

 pre-push :
  parallel : true

• 靈活的文件列表

如果您想要自己的列表。定制和預構建示例。

 pre-commit :
  commands :
    frontend-linter :
      run : yarn eslint {staged_files}
    backend-linter :
      run : bundle exec rubocop --force-exclusion {all_files}
    frontend-style :
      files : git diff --name-only HEAD @{push}
      run : yarn stylelint {files}

• 地球和正則過濾器

如果要過濾文件列表。您可以在此處找到更多的Glog模式示例。

 pre-commit :
  commands :
    backend-linter :
      glob : " *.rb " # glob filter
      exclude : ' (^|/)(application|routes).rb$ ' # regexp filter
      run : bundle exec rubocop --force-exclusion {all_files}

• 在子目錄中執行

如果要在相對路徑中執行命令

 pre-commit :
  commands :
    backend-linter :
      root : " api/ " # Careful to have only trailing slash
      glob : " *.rb " # glob filter
      run : bundle exec rubocop {all_files}

• 運行腳本

如果Oneline命令不夠，則可以執行文件。文件

 commit-msg :
  scripts :
    " template_checker " :
      runner : bash

• 標籤

如果要控制一組命令。文件

 pre-push :
  commands :
    packages-audit :
      tags :
        - frontend
        - linters
      run : yarn lint
    gems-audit :
      tags :
        - backend
        - security
      run : bundle audit

• 支持Docker

如果您在Docker環境中。文件

 pre-commit :
  scripts :
    " good_job.js " :
      runner : docker run -it --rm <container_id_or_name> {cmd}

• 本地配置

如果您是前端/後端開發人員，並且想跳過不必要的命令或將某些內容替補進入Docker。文件

 # lefthook-local.yml
pre-push :
  exclude_tags :
    - frontend
  commands :
    packages-audit :
      skip : true

• 直接控制

如果您想直接運行掛鉤組。

$ lefthook run pre-commit

• 您自己的任務

如果您想直接運行特定的命令組。

 fixer :
  commands :
    ruby-fixer :
      run : bundle exec rubocop --force-exclusion --safe-auto-correct {staged_files}
    js-fixer :
      run : yarn eslint --fix {staged_files} 

$ lefthook run fixer

• 控制輸出

您可以控制使用輸出選項的Lefthook打印。

 output :
  - execution
  - failure

---

嚮導

• 使用node.js安裝
• 與Ruby一起安裝
• 與自製的安裝
• 與Winget安裝
• 為基於Debian的Linux安裝
• 安裝基於RPM的Linux
• 安裝Arch Linux
• 安裝Alpine Linux
• 用法
• 配置

例子

檢查示例

文章

• 5個酷（令人驚訝的）配置自動化歡樂的方式
• Lefthook：將團隊的代碼恢復原狀
• lefthook +水晶球
• 與Docsify，Lefthook和朋友保持OSS文檔
• 自動覆蓋碼頭容器
• 使用lefthook的Dockerdev環境中的平滑postgresql升級
• React/React本地應用程序的Lefthook