Skip to content

Latest commit

 

History

History
123 lines (87 loc) · 4.48 KB

README.md

File metadata and controls

123 lines (87 loc) · 4.48 KB

Commit Generator

Gere commits com IA

English | Português

Commit Generator é uma ferramenta que utiliza IA para gerar automaticamente mensagens de commit com base nas alterações no seu código.

📌 Sumário

🔹 O que é o Gerador de Commits?

Escrever mensagens de commit significativas pode ser tedioso, e mensagens inconsistentes tornam o histórico de versões difícil de navegar.

Gerador de Commits elimina essa dificuldade ao analisar suas mudanças de código e gerar mensagens de commit claras, estruturadas e relevantes automaticamente.

🚀 Começando

Atualmente, a principal forma de interação com Commit Generator é por meio da CLI.

📋 Requisitos

Antes de instalar, certifique-se de que você possui as seguintes dependências:

  • Node.js (Necessário para rodar a CLI)
  • Git (Usado para gerenciamento de repositórios)

🔧 Instalação

Siga os passos abaixo para instalar e configurar o Commit Generator:

  1. Instale o pacote
npm install --global @commit-generator/cli
  1. Inicialize a configuração da IA
commitgen config init

🎯 Uso

Após a instalação, siga esses passos para gerar mensagens de commit usando IA.

  1. Adicione seus arquivos modificados ao staging
git add .
  1. Gere uma mensagem de commit
commitgen

🎉 Pronto! O Gerador de Commits irá analisar suas mudanças no staging e sugerir uma mensagem de commit significativa.

Para mais detalhes, consulte a documentação da CLI .

Funcionalidades

✅ Geração de mensagens de commit com IA – Usa IA para analisar mudanças no código e gerar mensagens de commit significativas.

✅ Integração sem falhas com Git – Analisa diffs do Git e arquivos em staging para sugestões precisas de commits.

✅ Tipos de commit padronizados – Suporta feat, fix, chore, docs, refactor, test, style, build, ci, perf, e revert.

✅ Commits com contexto – Adiciona contexto extra (por exemplo, números de issue, escopo ou detalhes adicionais) para mais clareza.

✅ Commits automáticos – Use --force para realizar commits instantâneos sem confirmação manual.

✅ Edição e gerenciamento de histórico de commits – Modifique, emende e valide mensagens de commit facilmente com comandos como commitgen edit, commitgen amend e commitgen validate.

✅ Validação de mensagens de commit – Garante que as mensagens sigam as melhores práticas e fornece recomendações.

✅ Provedor de IA configurável – Personalize as configurações da IA via commitgen config, com opções para definir, remover e listar configurações.

📂 Estrutura do Projeto

commit-generator/
│── docs/                   # Arquivos de documentação
│── packages/
│   ├── git/                # Integração com Git
│   ├── ai-models/          # Gerencia interações com modelos de IA
│   ├── prompt-parser/      # Converte templates de texto em prompts estruturados
│   ├── commit-history/     # Registra mensagens de commit geradas anteriormente
│   ├── config/             # Gerenciador de configurações
│   ├── eslint-config/      # Configurações do ESLint pré-configuradas
│   ├── typescript-config/  # Configurações do TypeScript
│── projects
│   ├── core/               # Lógica principal para geração de commits
│   ├── cli/                # Interface CLI para o gerador de commits
│── .gitignore
│── package.json
│── README.md

Cada pacote é documentado separadamente. Veja:

📜 Licença

O Gerador de Commits é um projeto open-source e está licenciado sob a Licença MIT. Fique à vontade para usar, modificar e contribuir!