security-commit v1.0.8

security-commit

security-commit é uma biblioteca que automatiza a configuração do Husky para rodar scripts personalizados durante o fluxo de commits no Git.

Isso inclui:

1. Verificação e correção de vulnerabilidades.
2. Verificação de presença de console.log.
3. Verificação de tokens do GitHub exporto.
4. Verificação de dependências não utilizadas.
5. Verificação se a branch está atualizada com a principal.

Instalação

Para adicionar esta biblioteca ao seu projeto, execute:

npm install security-commit

Configuração do Husky

Após a instalação da biblioteca, você precisará configurar o Husky no seu projeto. Isso é feito executando um script que já vem com a biblioteca:

node node_modules/security-commit/configureHusky.js

Esse comando irá: 1. Instalar o Husky se ele ainda não estiver instalado. 2. Inicializar o Husky no projeto. 3. Adicionar um hook de pre-commit que executa seu script customizado, responsável por verificar vulnerabilidades, console.log, tokens do GitHub, dependências não utilizadas, e garantir que a branch esteja atualizada com a branch principal.

O que o pre-commit faz?

Após a configuração, o hook de pre-commit irá rodar automaticamente sempre que você tentar fazer um commit. Ele fará o seguinte:

1. Verificar por vulnerabilidades nas dependências usando npm audit.
2. Procurar por console.log no código, avisando se algum deles ainda estiver presente.
3. Verificar a presença de tokens do GitHub expostos, como ghp_ ou github_pat.
4. Verificar por dependências não utilizadas com depcheck.
5. Verificar se a branch atual está atualizada com a branch principal (main ou master), garantindo que você não esteja atrás de commits importantes.

Apenas se a verificação de token exposto e atualização de branch falhar, o commit será abortado até que os problemas sejam resolvidos.

Exemplo de uso

Aqui está um exemplo de fluxo que ocorre após a configuração do security-commit:

1. Você faz alterações no código e tenta executar git commit.
2. O Husky é acionado automaticamente e executa todas as verificações.
3. Se tudo estiver correto, o commit será realizado. Caso contrário, o commit será abortado, e você receberá uma mensagem de erro explicando o que precisa ser corrigido.

Atualizando o Husky

Se precisar reconfigurar o Husky em um projeto já existente, você pode rodar novamente o comando:

node node_modules/security-commit/configureHusky.js

Isso irá garantir que o Husky esteja configurado corretamente com os hooks atualizados.

Contribuição

Se você encontrar algum problema ou tiver sugestões para melhorar essa biblioteca, sinta-se à vontade para abrir uma issue ou enviar um pull request.