Skip to content

README.md

Latest commit

 

History

History
101 lines (70 loc) · 3.45 KB

README.md

File metadata and controls

101 lines (70 loc) · 3.45 KB
Raw

Assistente de commits

Monitoramento Automático de Alterações no Projeto

Este projeto implementa um sistema para monitorar e versionar automaticamente mudanças em um repositório Git, evitando commits desnecessários causados por alterações irrelevantes como espaços ou linhas em branco.

Objetivo

Evitar que o script acione commits automáticos para mudanças temporárias ou irrelevantes. A detecção considera apenas modificações realmente relevantes no conteúdo do código ou arquivos do projeto.

Diferença entre Abordagens

  • Snapshot: varre todos os arquivos no diretório, detectando qualquer modificação, mesmo fora do controle do Git. Isso não seria tecnicamente uma melhor abordagem, só apresento para deixar em aberto as possibilidade

  • git diff: considera apenas arquivos rastreados no repositório e ignora mudanças irrelevantes como espaços ou linhas em branco.

Abordagem Utilizada

Para evitar notificações por mudanças irrelevantes (como quebras de linha temporárias ou espaços removidos em seguida), a estratégia é detectar apenas alterações realmente novas comparando o estado do último commit com o estado atual.

  1. Tirar um snapshot (hash) do repositório no início.

  2. Monitorar mudanças usando:

    • -w / --ignore-all-space Ignora todas as mudanças de espaço em branco ao comparar
    • --unified=0 Com =0, ele mostra apenas as linhas alteradas, nada mais
    • HEAD É a referência para o último commit no branch atual.
    • --ignore-blank-lines: ignora linhas em branco.
    • --ignore-space-change: ignora diferenças de espaços e indentação.

  3. Quando detectar diferença relevante:

    • Executar git add .
    • Executar git commit -m "mensagem"
    • Executar git push

O comando está comparando as alterações ainda não commitadas com o último commit feito

Resumo funcional

git diff -w --unified=0 --ignore-blank-lines --ignore-space-change HEAD

Observação: é possível adicionar etapas extras (build, testes, linting) conforme a complexidade do projeto.

Critérios de Alterações Relevantes

  • Inclusas: mudanças que afetam o conteúdo real do código ou arquivos rastreados.
  • Ignoradas: ajustes de indentação, linhas em branco ou espaços extras.

Quantidade Mínima de Impacto

  • Commit automático somente se o número de linhas modificadas (adições + remoções) for maior que ou igual 5.
  • Esse limite pode ser ajustado conforme a necessidade (por exemplo, exigir no mínimo 5 linhas modificadas).
  • Também é possível ajustar o intervalo entre verificações para controlar a frequência de acionamento.

Como Usar

Guia rápido para instalar e executar o script a partir de qualquer lugar no terminal.

1. Colocar o Script no Local Correto

Escolha um diretório para guardar seus scripts pessoais:

mkdir -p ~/scripts
mv assitant_commit ~/scripts/

2. Criar um Atalho Global (Link Simbólico)

Permite rodar o script como um comando simples:

ln -s ~/scripts/assitant_commit.py ~/.local/bin/assitant_commit

3. Garantir que o Diretório esteja no PATH

Edite o arquivo de configuração do shell (.zshrc):

nano ~/.zshrc

Adicione a linha:

export PATH="$HOME/.local/bin:$PATH"

4. Recarregar as Configurações

source ~/.zshrc

5. Testar no Terminal

monitor_repo

Dica: é possível renomear o comando no passo do link simbólico para algo mais curto, como mon ou pushauto.