thatdudealso/consistent-naming

Nomenclatura Consistente

Pare com nomes aleatórios. Cada novo nome deve parecer que já pertencia à árvore alvo — arquivos inclusos.

Regra rígida

Antes de propor ou escrever qualquer novo nome:

1. Escolha o escopo de nomenclatura (references/scope.md): irmãos → pacote → raiz git → projetos irmãos no disco → padrões da casa.
2. Execute scripts/survey-names.sh nesse escopo (e --siblings para novos projetos).
3. Leia references/rules.md para o tipo de nome.
4. Proponha um nome primário mais no máximo duas alternativas, cada uma justificada por exemplos concretos do levantamento.
5. Se os padrões conflitarem, prefira a vizinhança local, depois uma frase explicando o porquê.

Não envie nomes bobos, engraçadinhos ou únicos que ignorem os vizinhos. Não reutilize o estilo do repositório A dentro do repositório B sem levantar o B.

Fluxo de trabalho

1. Classifique o tipo de nome (references/kinds.md): projeto, pacote, diretório, arquivo, arquivo de sistema/configuração, componente, teste, env, branch, skill, cli, api/rota.

2. Levante o caminho proprietário (não uma raiz de workspace aleatória):

   scripts/survey-names.sh [caminho]
   # para novo projeto / produto também:
   scripts/survey-names.sh --siblings [pai-dos-projetos]
   

3. Combine caixa e separadores para aquele tipo naquela pasta (diretórios kebab, componentes PascalCase, env SCREAMING_SNAKE, nomes de ferramentas fixos).

4. Combine vocabulário já existente naquela árvore. Reutilize radicais; evite bifurcações de sinônimos (auth/ ao lado de authentication/).

5. Verifique colisões contra o levantamento, repositórios irmãos e nomes de pacotes/PATH. Sem sufixos 2, final, novo, copia.

6. Saída:

   Primário: <nome>
   Escopo: <caminho levantado>
   Padrão: <regra + 1-2 exemplos reais>
   Rejeitado: <alternativas e porquê>
   

Arquivos e arquivos de sistema

• Arquivos fonte comuns: combine o estilo do nome base dos irmãos + extensão exatamente.
• Arquivos de sistema/configuração/ferramentas: prefira nomes fixos idiomáticos (.env.example, docker-compose.yml, AGENTS.md, flake.nix, nomes de workflow kebab). Veja references/scope.md.

Padrões quando vazio

Se o levantamento encontrar quase nada, use references/defaults.md e mantenha-se consistente a partir do primeiro nome.

Anti-padrões

• Codinomes aleatórios de animais/comida a menos que esse tema já exista no escopo
• Espaços em novos caminhos; pastas em Title Case ao lado de irmãos kebab
• Misturar camelCase e kebab-case na mesma pasta
• Aplicar o estilo da casa deste workspace a um repositório não relacionado sem levantá-lo
• "Melhorar" nomes de arquivos de sistema obrigatórios (package.json → pkg.json)
• utils2.ts, helpers-novo.ts, tmp-final.tsx

Recursos agrupados

Caminho	Quando
scripts/survey-names.sh	Sempre antes de nomear
references/scope.md	Multi-repo, arquivos, nomes de sistema/config
references/rules.md	Caixa / separador por tipo
references/kinds.md	Classificar a solicitação
references/defaults.md	Somente em campo verde