Download captainhook - download do código-fonte captainhook

captainhook

Outras categorias

5.24.1

Baixar

Capitão Gancho

CaptainHook é uma biblioteca git hook fácil de usar e muito flexível para desenvolvedores php. Ele permite que você configure suas ações do git hook em um arquivo json simples.

Você pode usar o CaptainHook para validar ou preparar suas mensagens de commit, garantir a qualidade do código ou executar testes de unidade antes de confirmar ou enviar alterações para o git. Você pode limpar automaticamente os caches locais ou instalar as dependências mais recentes do compositor após obter as alterações mais recentes.

CaptainHook facilita o compartilhamento de ganchos dentro de sua equipe e ainda pode garantir que todos em sua equipe ativem os ganchos localmente.

Você pode executar comandos cli, usar alguns validadores integrados ou escrever suas próprias classes PHP que são executadas por CaptainHook . Para mais informações dê uma olhada na documentação.

Instalação

O método preferido para instalar o CaptainHook é instalar o arquivo PHAR. Você pode fazer isso usando Phive ou baixando o PHAR na página de lançamento do GitHub.

 phive instalar capitãohook

Ou use o Composer para instalá-lo.

 compositor requer --dev capitãohook/captainhook-phar

Se você deseja obter o código fonte com todas as suas dependências você pode usar:

 compositor requer --dev capitãohook/captainhok

Configurar

Depois de instalar o CaptainHook, você pode usar o executável do Captainhook para criar uma configuração.

 configuração de fornecedor/bin/capitão

Depois de criar o arquivo de configuração capitahook.json , você deve ativar os ganchos instalando-os em seu diretório .git local. Para fazer isso, basta executar o seguinte comando CaptainHook .

 instalação de fornecedor/bin/captainhook

Dê uma olhada neste breve vídeo de instalação.

Um dos objetivos do CaptainHook é tornar mais fácil para uma equipe usar os mesmos git hooks. Se você quiser ter certeza de que todos realmente instalam os ganchos, você pode usar o pequeno plugin do Composer hook-installer . Ele executa o comando captainhook install sempre que você executa um comando do Composer .

 compositor requer --dev capitãohook/hook-installer

É claro que os colegas de equipe ainda podem fazer commit sem executar os ganchos, é por isso que você também deve executar verificações apropriadas no backend. Mas pelo menos assim ninguém pode esquecer de instalá-los “por acidente”.

Configuração

Aqui está um exemplo de arquivo de configuração capitahook.json .

 { "commit-msg": {"enabled": true,"ações": [
      {"action": "CaptainHookAppHookMessageActionBeams" }
    ]
  }, "pré-commit": {"enabled": true,"actions": [
      {"ação": "phpunit" },
      {"action": "phpcs --standard=psr2 src" }
    ]
  }, "pré-push": {"enabled": false,"actions": []
  }
}