Pular para o conteúdo
EN · PT

Gate: rule-types

Every code letter is declared in the vocabulary, with no conflict.

Propriedade Valor
Verificação rule-types
Confronta spec
Bloqueante por padrão — projeto novo sim
Bloqueante por padrão — projeto existente não — informa
Duplicidade uma declaração que ele controla repetida no mesmo arquivo o reprova; duplicates: false desliga
gates:
- name: rule-types
on: [spec]
check: rule-types

Fonte: verificação · sua spec (em inglês)


Garante que os prefixos e letras de códigos seguem a declaração de tipos de regras do projeto.

Em termos simples: este gate garante que o seu software não cometa erros por descuido ou falta de sincronização. Se você ou uma inteligência artificial alterar um arquivo coberto por este gate, ele inspeciona o trabalho imediatamente.


Mantém o vocabulário de letras de regras padronizado em todo o repositório.

Sem este gate ativo, esse tipo de defeito passa despercebido pelos testes comuns e só estoura em produção ou durante refatorações dolorosas semanas depois.


Compara as letras de regras usadas nas specs contra o vocabulário rule_types do anchors.yaml.

  • ✓ Pass (Aprovado): Todas as letras de códigos pertencem ao vocabulário oficial.
  • ✗ Fail (Reprovado): Letra de código não cadastrada no anchors.yaml.
  • ~ Indeterminado/Pending: Não se aplica.
  • Skip (Dispensado): Não se aplica.

Para ativar este gate no seu projeto, adicione o bloco abaixo na seção gates: do seu anchors.yaml:

gates:
- name: rule-types
blocking: true
measures: "as letras dos códigos estão no vocabulário declarado"

  • Quando ativar: Bloqueante para manter a consistência da taxonomia.
  • Fase de execução: Configure em when: [pre-commit, ci] para verificações rápidas, ou when: [pre-push, ci] para gates que rodam ferramentas mais pesadas.
  • Transição de maturidade: Comece com blocking: false para avaliar o estado atual do repositório com anchors check. Quando zerar as ocorrências, altere para blocking: true.

Se o anchors check acusar falha (✗) neste gate:

  1. Use as letras padrão (B, V, E, S, DS, VR) ou declare a nova letra em rule_types.
  2. Reexecute a verificação no terminal:
    Terminal window
    anchors check
  3. Se o gate suportar correção automática, você pode tentar o comando:
    Terminal window
    anchors check --fix