@d3vPadawann/commit-devil

Padronização de commits para projetos. Configura commitizen, commitlint e husky automaticamente através de um wizard interativo.

Instalação

npm install @d3vPadawann/commit-devil -D

Setup

npx commit-devil init

O wizard vai perguntar:

1. Escopos do projeto (components, hooks, services, etc.)
2. Prefixo do Jira (ex: ABDP-)
3. Padrão do ticket (regex, ex: \d{4})
4. Ticket obrigatório?
5. Limite de caracteres do subject e header
6. Comandos do pre-commit (ex: npx lint-staged)
7. Comandos do pre-push (ex: npm run test)

Arquivos gerados

| Arquivo | Descrição | | --------------------------- | --------------------------- | | .commit-devilrc.json | Configuração do projeto | | commitlint.config.cjs | Config do commitlint | | .cz-config.cjs | Config do commitizen | | .husky/commit-msg | Hook de validação do commit | | .husky/prepare-commit-msg | Hook do commitizen | | .husky/pre-commit | Hook customizável | | .husky/pre-push | Hook customizável |

Uso

# Via npm script
npm run commit

# Via git (o hook prepare-commit-msg ativa o commitizen)
git commit

Reconfigurar

npx commit-devil init --force

Tipos de commit

| Tipo | Descrição | | ---------- | ---------------------------------- | | feat | Uma nova funcionalidade | | patch | Adição de pequena funcionalidade | | fix | Correção de bug | | docs | Apenas documentação | | style | Formatação (sem mudança de código) | | refactor | Refatoração de código | | perf | Melhoria de performance | | test | Adicionando ou corrigindo testes | | build | Mudanças no build ou dependências | | ci | Mudanças na configuração de CI | | chore | Tarefas de manutenção | | revert | Reverte um commit anterior | | wip | Work in progress | | merge | Merge de branches |

Regras de validação

• ❌ Subject vazio
• ❌ Subject contendo apenas o prefixo do ticket (ex: [ABDP-1234])
• ❌ Tipo de commit inválido
• ❌ Header excedendo limite de caracteres

Desenvolvimento

# Build
npm run build

# Watch mode
npm run dev

commit-devil