Pular para o conteúdo
EN · PT

Gate: code-cataloged

Every exported symbol has a rule in the spec or a written waiver.

Propriedade Valor
Verificação code-cataloged
Confronta spec
Bloqueante por padrão — projeto novo sim
Bloqueante por padrão — projeto existente não — informa
gates:
- name: code-cataloged
on: [spec]
check: code-cataloged

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


Garante que todo símbolo público (função, tipo, export) exportado pelo código está catalogado na spec.

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.


Impede o surgimento de código fantasma ou funções públicas criadas sem especificação que ninguém sabe o que fazem.

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.


Analisa o código procurando funções/tipos exportados e confronta com a spec que governa o arquivo.

  • ✓ Pass (Aprovado): Todos os símbolos exportados têm regra correspondente na spec ou dispensa com @no-rule.
  • ✗ Fail (Reprovado): Função pública exportada sem nenhuma menção na spec dona.
  • ~ Indeterminado/Pending: Spec ainda não criada.
  • Skip (Dispensado): Camadas reconhecidas (infra, dao, types) ou arquivos com regime declarativo.

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

gates:
- name: code-cataloged
blocking: true
measures: "todo símbolo exportado tem regra na spec ou dispensa"

  • Quando ativar: Bloqueante em bibliotecas e serviços de negócio.
  • 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. Documente a função na spec correspondente ou marque com @no-rule no código explicando o motivo.
  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