githooks

1. Wtyd/githooks

São muitas outras ferramentas e plugins de compositor para gerenciar ganchos Git. Mas Githooks oferece:

• Aplicativo independente. Githooks é um binário (.phar), portanto suas dependências não interferem nas dependências do seu aplicativo.
• É gerenciado com compositor. Você não precisa de outras ferramentas como Phive ou outras pessoas.
• Crentraliza toda a configuração de ferramentas de QA (pelo menos todas as ferramentas suportadas).
• Ele abstrai os desenvolvedores de como as ferramentas de controle de qualidade devem ser executadas usando apenas o comando githooks tool name-of-the-tool .
• Você também pode criar seus próprios scripts e configurar qualquer gancho git.

Além disso, ele pode ser usado junto com ferramentas de validação de JavaScript, como Tipicode/Husky, se você tiver projetos híbridos.

2. Requisitos

• Php> = 7.1
• As ferramentas que você precisa para verificar o código.
• Ou seus próprios scripts para os ganchos.

3. Instale

1. Githooks deve ser instalado como o requisito de dev com o compositor:

composer require --dev wtyd/githooks

NOTA: Para PHP <8.1, você deve adicionar o próximo evento post-update-cmd à seção scripts em seu composer.json :

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

Em seguida, execute composer update wtyd/githooks .

Até a versão 2.3.0, o método utilizado foi php72orminorupdate , mas foi depreciado e será removido da versão 3.0.0

Também é conveniente adicioná-lo ao evento post-install-cm para que o restante dos desenvolvedores do projeto não tenha problemas com a construção

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

2. Instale todas as ferramentas suportadas necessárias. Como você instala as ferramentas não importa.

3. Inicialize Githooks com githooks conf:init . Este comando cria o arquivo de configuração no caminho root ( githooks.yml ).

4. Corra githooks hook . Ele copia o script para o lançamento de Githooks no evento pré-comprometimento no diretório .git/hooks . Você também pode executar githooks hook otherHook MyScriptFile.php para definir qualquer gancho com um script personalizado. Veja o wiki para obter mais informações.

Para garantir que ele esteja configurado automaticamente, podemos configurar o comando nos eventos post-update-cmd e post-install-cmd do arquivo composer.json (seção scripts ):

 "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. Defina o arquivo de configuração.

4. Uso

Quando você se compromete, todas as ferramentas de verificação de código configuradas são iniciadas automaticamente. Se o seu código passar em todas as verificações, o Githooks permitirá que você se comprometa. Caso contrário, você deve consertar o código e tentar novamente:

Você também pode executar Githooks sempre que quiser. Todas as ferramentas ao mesmo tempo ou uma a uma:

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

5. Ferramentas suportadas

Neste momento, as ferramentas suportadas são:

• Codesniffer PHP (PHPCs e PHPCBF)
• Detector de pasta de cópia php
• Detector de bagunça PHP
• Paralelo-lint
• PHP Stan
• Verificador de segurança PHP local

Mas você pode definir seu próprio script em qualquer gancho git.

6. Defina o arquivo de configuração

O arquivo githooks.yml é dividido em três partes:

6.1. Opções

6.1.1. Execução

A bandeira execution marca como os githooks serão executados:

• full (a opção padrão): executa sempre todas as ferramentas definidas contra todo o caminho definido para cada ferramenta. Por exemplo, você definiu PHPCs para execução nos diretórios de src e app . O comprometimento contém apenas arquivos modificados no diretório database . Os PHPCs verificarão os diretórios de src e app , mesmo que nenhum arquivo nesses diretórios tenha sido modificado.
• fast : esta opção executa as ferramentas apenas contra arquivos modificados por Commit.
  • Esta opção afeta apenas as seguintes ferramentas: PHPCs, PHPMD, Phpstan e Parallel-Lint. O restante das ferramentas será executado como a opção completa.
  • AVISO!!! Você deve definir as exclusão das ferramentas em githooks.yml ou no arquivo de configuração da ferramenta EATH, pois essa opção substitui os principais paths das ferramentas para que elas sejam executadas apenas nos arquivos modificados.

6.1.2. Processos

Execute várias ferramentas em vários processos ao mesmo tempo (comando tool all ). O número padrão de processos é 1.

6.2. Ferramentas

É uma matriz com o nome das ferramentas que os Githooks executarão. O nome das ferramentas é o executável. Se você deseja que todas as ferramentas sejam executadas, a chave Tools será a seguinte:

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

A ordem em que as ferramentas são é a ordem em que serão executadas.

6.3. Ferramentas de configuração

Na próxima etapa, você deve configurar as ferramentas com o mesmo nome da tecla Tools . Por exemplo, para definir PHPCs:

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

Todas as opções disponíveis estão no wiki.

7. Contribuindo

As contribuições de outros seriam muito apreciadas! Enviar solicitação de puxar/emissão. Verifique todas as etapas para fazer isso na seção wiki para contribuir. Obrigado!

8. Licença

A licença do MIT (MIT). Consulte o arquivo de licença para obter mais informações.