Installation

yarn add commitizen @omie.gclick/commit-padronizados

e então adicione o seguinte ao package.json:

{
  "scripts": {
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/@omie.gclick/commit-padronizados"
    }
  }
}

Configuração Dinâmica

Alternativamente, se você quiser criar seu próprio perfil, pode usar a abordagem configurável. Aqui está um exemplo:

./index.js

const custom = require('@omie.gclick/commit-padronizados/configurable');
// Opcionalmente, você pode estender os tipos de commit
const defaultTypes = require('@omie.gclick/commit-padronizados/types');

module.exports = custom({
  types: {
    ...defaultTypes,
    perf: {
      description: 'Melhorias que tornarão seu código mais eficiente',
      title: 'Desempenho'
    }
  },
  skipScope: false,
  scopes: ['meuEscopo1', 'meuEscopo2'],
  customScope: true
});

./package.json

{
  "config": {
    "commitizen": {
      "path": "./index.js"
    }
  }
}

Este exemplo:

• Exibirá "perf" como um tipo extra de commit
• Pedirá para adicionar um escopo ao commit
• Limitará a seleção de escopo para meuEscopo1 ou meuEscopo2

Lista de todas as opções configuráveis suportadas ao usar a abordagem configurável:

| Chave | Padrão | Descrição | | --------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | jiraMode | true | Se definido como verdadeiro, CZ pedirá um número de Jira e o incluirá no cabeçalho do commit. Se falso, CZ perguntará pelo Jira no final e pode ser usado para GitHub. | | maxHeaderWidth | 72 | Define o comprimento máximo do cabeçalho da mensagem de commit. | | minHeaderWidth | 2 | Define o comprimento mínimo da mensagem de commit. | | maxLineWidth | 100 | Define o comprimento máximo das linhas na descrição do commit. | | skipScope | true | Define se o escopo deve ser utilizado nas mensagens de commit. | | defaultType | undefined | Define o tipo padrão. | | defaultScope | undefined | Define o escopo padrão. | | defaultSubject | undefined | Define um assunto padrão. | | defaultBody | undefined | Define um corpo padrão. | | defaultIssues | undefined | Define uma issue padrão. | | jiraPrefix | 'DAZ' | Define o prefixo padrão do ticket Jira que será exibido. | | types | ./types.js | Lista (objeto JS) de tipos de commit suportados. | | scopes | undefined | Lista (array JS) de escopos disponíveis para seleção. Nota: adicionar isto muda o campo de escopo de um input para uma lista. | | customScope | false | Se definido como verdadeiro, os usuários podem fornecer um escopo personalizado, além dos predefinidos no array scopes. Neste caso, a opção 'custom' aparecerá na lista e permitirá uma entrada personalizada. | | jiraOptional | false | Se definido como verdadeiro, o campo Jira pode ser deixado em branco. | | jiraLocation | "pre-description" | Define a posição do ID do Jira. Opções: pre-type, pre-description, post-description, post-body. | | jiraPrepend | "" | Adiciona um prefixo opcional ao ID do Jira. Exemplo: [DAZ-1234. | | jiraAppend | "" | Adiciona um sufixo opcional ao ID do Jira. Exemplo: DAZ-1234]. | | exclamationMark | false | Em casos de breaking changes, adiciona um ponto de exclamação (!) após o escopo, por exemplo: type(scope)!: quebra de compatibilidade. Quando ativado, reduz o comprimento permitido do cabeçalho em 1. |