@gilbert_oliveira/commit-wizard 1.0.19 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +53 -31
  2. package/package.json +3 -4
package/README.md CHANGED
@@ -1,58 +1,80 @@
1
1
  # Commit Wizard
2
2
 
3
- O **Commit Wizard** é uma ferramenta automatizada para a geração de mensagens de commit com base na convenção de **Conventional Commits**. Ele ajuda a garantir que suas mensagens de commit sigam um padrão consistente e facilite a comunicação de mudanças no código.
3
+ Gere mensagens de commit convencionais automaticamente com base nas alterações no código usando a API da OpenAI.
4
4
 
5
- ## Funcionalidades
5
+ ## ✨ Visão Geral
6
6
 
7
- - Geração automática de mensagens de commit usando o **Cody**.
8
- - Garantia de que a mensagem de commit siga o padrão **Conventional Commits**.
9
- - Oferece a opção de editar ou confirmar a mensagem gerada.
10
- - Verificação se o repositório Git está inicializado e se o usuário está autenticado no **Cody**.
11
- - Integração com a ferramenta **Cody** para sugestão de mensagens de commit baseadas no diff de código.
7
+ Este projeto é uma ferramenta de linha de comando (CLI) chamada `commit-wizard`, que utiliza a API da OpenAI para gerar mensagens de commit com base no `diff` dos arquivos que estão em *staged* no Git.
12
8
 
13
- ## Instalação
9
+ ## 🚀 Instalação
14
10
 
15
- ### Requisitos
16
-
17
- - **Node.js**: A ferramenta requer o **Node.js** para ser executada.
18
- - **Cody**: A ferramenta usa o **Cody** da Sourcegraph para gerar as mensagens de commit.
19
-
20
- ### Instalação Global
11
+ ```bash
12
+ npm install -g commit-wizard
13
+ ```
21
14
 
22
- Para instalar o Commit Wizard globalmente, execute o seguinte comando:
15
+ Ou, se estiver usando localmente:
23
16
 
24
17
  ```bash
25
- npm install -g @gilbert_oliveira/commit-wizard
18
+ npm install
26
19
  ```
27
20
 
28
- ### Instalação Local
21
+ ## ⚙️ Configuração
29
22
 
30
- Para instalar o Commit Wizard localmente, execute o seguinte comando:
23
+ Antes de usar, você precisa definir a variável de ambiente com sua chave da OpenAI:
31
24
 
32
25
  ```bash
33
- npm install @gilbert_oliveira/commit-wizard
26
+ export OPENAI_API_KEY=sk-...
34
27
  ```
35
28
 
36
- ## Uso
29
+ Você pode adicionar isso no seu `.bashrc`, `.zshrc` ou arquivo de ambiente equivalente.
37
30
 
38
- Para usar o Commit Wizard, execute o seguinte comando no terminal:
31
+ ## 🧠 Como Funciona
32
+
33
+ 1. O script lê os arquivos que estão em *staged* (`git diff --cached`).
34
+ 2. Envia esse diff para a API da OpenAI.
35
+ 3. Recebe uma sugestão de mensagem de commit no formato convencional (`feat:`, `fix:`, etc).
36
+ 4. Exibe a mensagem para revisão.
37
+
38
+ ## 📝 Exemplo de Uso
39
39
 
40
40
  ```bash
41
- commit-wizard
41
+ npx commit-wizard
42
42
  ```
43
43
 
44
- O Commit Wizard irá gerar uma mensagem de commit com base nas mudanças no repositório Git e na convenção de **Conventional Commits**. Você pode editar a mensagem gerada ou confirmá-la.
44
+ Resultado esperado:
45
45
 
46
- ## Contribuição
46
+ ```
47
+ Sugestão de commit:
48
+ feat: adiciona verificação automática para arquivos staged usando GPT-4
49
+ ```
47
50
 
48
- Se você quiser contribuir com o Commit Wizard, siga as instruções abaixo:
51
+ ## 🛠 Tecnologias Utilizadas
49
52
 
50
- 1. Faça um fork do repositório.
51
- 2. Crie uma nova branch com a sua feature: `git checkout -b my-feature`
52
- 3. Faça o commit das suas alterações: `git commit -m 'feat: My new feature'`
53
- 4. Faça o push para a sua branch: `git push origin my-feature`
54
- 5. Abra um Pull Request
53
+ - Node.js
54
+ - TypeScript
55
+ - OpenAI API
56
+ - Commander (CLI)
57
+ - Dotenv
55
58
 
56
- ## Licença
59
+ ## 🧪 Scripts Disponíveis
60
+
61
+ - `npm run build`: compila o TypeScript para JavaScript.
62
+ - `npm start`: executa o CLI direto pelo TypeScript (com ts-node).
63
+ - `npm run dev`: roda em modo de desenvolvimento com `ts-node-dev`.
64
+
65
+ ## ✅ Commit Convencional
66
+
67
+ Este projeto segue o padrão de commit convencional, como:
68
+
69
+ - `feat:` para novas funcionalidades
70
+ - `fix:` para correções de bugs
71
+ - `docs:` para documentação
72
+ - `refactor:` para mudanças internas no código
73
+
74
+ ## 📄 Licença
57
75
 
58
76
  Este projeto está licenciado sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
77
+
78
+ ---
79
+
80
+ Feito com 💜 por Gilbert de Oliveira Santos
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gilbert_oliveira/commit-wizard",
3
- "version": "1.0.19",
3
+ "version": "1.0.21",
4
4
  "description": "O **Commit Wizard** é uma ferramenta automatizada para geração de mensagens de commit com base na convenção de **Conventional Commits**. Ele ajuda a garantir que suas mensagens de commit sigam um padrão consistente e facilite a comunicação de mudanças no código.",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",
@@ -41,10 +41,9 @@
41
41
  "homepage": "https://github.com/gilbert-oliveira/commit-wizard#readme",
42
42
  "dependencies": {
43
43
  "@types/node": "^22.14.1",
44
- "ts-node": "^10.9.2",
45
44
  "typescript": "^5.8.3",
46
45
  "gpt-tokenizer": "^1.0.0",
47
- "inquirer": "^12.5.2",
48
- "ora": "^8.2.0"
46
+ "ora": "^8.2.0",
47
+ "inquirer": "^12.5.2"
49
48
  }
50
49
  }