lint commit

Compromisso de fiapo

Descrição

Essa ferramenta CLI ajuda a automatizar o processo de geração de mensagens de compromisso e gerenciamento de um repositório Git. Ele orienta o usuário ao inicializar um repositório Git (se ainda não for inicializado), selecionando arquivos para comprometer mensagens de comprometimento assistido por AI e opcionalmente, empurrando alterações para um repositório remoto.

Características

• Inicialize um novo repositório Git, se ainda não for inicializado
• Selecione arquivos para se comprometer na lista de arquivos alterados
• Gerar mensagens de confirmação assistidas pela AI usando a API AI generativa do Google
• Opcionalmente, empurre as alterações no repositório remoto

Pré -requisitos

• Node.js (v14.x ou mais tarde)
• Git instalado em seu sistema
• Github CLI ( gh ) instalado
• Google Generative AI API Key: Google AI Studio

Instalação

1. Instale o comando de fiapos globalmente:

npm install -g lint-commit

2. Registre seu gemini_api_key:

lint-commit register

3. Como alternativa, você pode clonar este repositório e executar o script localmente:

git clone https://github.com/techwithmanuel/lint-commit.git
cd lint-commit
npm install
node register.js
node index.js

Como obter sua chave de API de Gêmeos

1. Entre no Google AI Studio

2. Selecione Get API key no menu lateral

3. Selecione Create API key e siga o prompt para criar a chave

4. Uma vez feito, copie a chave, execute este comando depois de instalar o comando de fiapos

 lint-commit register

Em seguida, digite a chave

Uso

Depois de instalar e resgatar seu GEMINI_API_KEY , para começar com o comando de fiapos, basta executar:

lint-commit

Siga os avisos para inicializar um repositório Git, adicionar arquivos e criar um commit com uma mensagem CommitLint-confort.

Contribuindo

As contribuições são bem -vindas! Siga estas etapas para contribuir:

1. Fork o repositório.
2. Crie uma nova ramificação (Git Checkout -b Recurso -rale).
3. Faça suas alterações e cometê -las (Git Commit -am 'Adicione novo recurso').
4. Empurre para o ramo (recurso de origem do git push).
5. Crie uma nova solicitação de tração.

Contato

Para qualquer dúvida ou sugestão, abra um problema.