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