lefthook

Um gerente de ganchos Git para Node.JS, Ruby, Python e muitos outros tipos de projetos.

• Rápido. Está escrito em Go. Pode executar comandos em paralelo.
• Poderoso. Ele permite controlar a execução e os arquivos que você passa para seus comandos.
• Simples. É um binário livre de dependência única que pode funcionar em qualquer ambiente.

Documentação

Leia o post de introdução

Instalar

Com go (> = 1,23):

go install github.com/evilmartians/lefthook@latest

Com npm :

npm install lefthook --save-dev

Para Ruby :

gem install lefthook

Para Python :

pip install lefthook

Guia de instalação com mais maneiras de instalar o Lefthook: Apt, Brew, Winget e outras.

Uso

Configure seus ganchos, instale -os uma vez e esqueça: confie na magia por baixo.

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 ' ... ' 

Mais detalhes

• Configuração das opções de configuração lefthook.yml .
• Uso para as opções de CLI de esquerda , ENVs suportados e dicas de uso.
• Discussões para perguntas, idéias, sugestões.

Por que lefthook

• Execução paralela

Dá mais velocidade. documentos

 pre-push :
  parallel : true

• Lista flexível de arquivos

Se você quiser sua própria lista. Exemplos personalizados e pré -construídos.

 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}

• Filtros Glob e Regexp

Se você deseja filtrar a lista de arquivos. Você pode encontrar mais exemplos de padrão global aqui.

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

• Executar em subdiretório

Se você deseja executar os comandos em um caminho relativo

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

• Execute scripts

Se os comandos online não forem suficientes, você poderá executar arquivos. documentos

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

• Tags

Se você deseja controlar um grupo de comandos. documentos

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

• Docker de suporte

Se você estiver no ambiente do Docker. documentos

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

• Config local

Se você é um desenvolvedor de front -end/back -end e deseja pular comandos desnecessários ou substituir algo no Docker. documentos

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

• Controle direto

Se você deseja executar o grupo de ganchos diretamente.

$ lefthook run pre-commit

• Suas próprias tarefas

Se você deseja executar o grupo específico de comandos diretamente.

 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

• Saída de controle

Você pode controlar o que o Lefthook impressa com a opção de saída.

 output :
  - execution
  - failure

---

Guias

• Instale com o Node.js
• Instale com Ruby
• Instale com homebrew
• Instale com Winget
• Instale para Linux baseado em Debian
• Instale o Linux baseado em RPM
• Instale para Arch Linux
• Instale para alpino linux
• Uso
• Configuração

Exemplos

Verifique exemplos

Artigos

• 5 maneiras legais (e surpreendentes) de configurar o Lefthook for Automation Joy
• Lefthook: bata o código da sua equipe de volta à forma
• Lefthook + Cristalball
• Mantendo a documentação da OSS sob controle com o docsify, lefthook e amigos
• Contêineres automaticamente lineando o docker
• Atualizações suaves de Postgresql em ambientes Dockerdev com o Lefthook
• Lefthook para react/react aplicativos nativos