Aplicador de Estilo de Código
Este skill garante que o código siga convenções e padrões de estilo específicos do projeto que linters automatizados podem não capturar.
Quando Usar Este Skill
- O usuário solicita revisão ou melhorias de estilo de código
- Garantir consistência em toda a base de código
- Integrar novos códigos ou contribuidores
- Revisão de código antes do commit
- O usuário menciona "estilo", "consistência", "formatação" ou "convenções"
Instruções
1. Detectar Guias de Estilo do Projeto
Procure por arquivos de configuração de estilo:
JavaScript/TypeScript:
.eslintrc.*- Configuração do ESLint.prettierrc.*- Configuração do Prettiertsconfig.json- Opções do compilador TypeScript.editorconfig- Configuração do editor
Python:
.pylintrc,pylint.cfg- Pylintpyproject.toml- Configuração do Black, isort.flake8- Configuração do Flake8setup.cfg- Configurações de várias ferramentas
Ruby:
.rubocop.yml- Configuração do RuboCop
Go:
go.fmtaplicado (padrão).golangci.yml- GolangCI-Lint
Java:
checkstyle.xml- Checkstyle.editorconfig
Geral:
CONTRIBUTING.md- Diretrizes de contribuiçãoSTYLE_GUIDE.md- Guia de estilo do projeto.editorconfig- Configurações entre editores
Use Glob para encontrar esses arquivos e Read para entender as preferências de estilo do projeto.
2. Analisar Padrões de Código Existentes
Amostrar código existente para entender convenções implícitas:
Organização de arquivos:
- Padrões de estrutura de diretórios
- Convenções de nomeação de arquivos (camelCase, kebab-case, snake_case)
- Organização de importações/exportações
Estrutura de código:
- Ordenação de classes/funções
- Posicionamento de métodos públicos vs privados
- Local de declaração de constantes/variáveis
Formatação:
- Indentação (espaços vs tabs, tamanho)
- Limites de comprimento de linha
- Uso de linhas em branco
- Estilos de comentários
Nomeação:
- Nomeação de variáveis (camelCase, snake_case)
- Nomeação de classes (PascalCase, capitalização)
- Nomeação de constantes (UPPER_CASE, etc.)
- Padrões de nomeação de arquivos
Use Grep para encontrar padrões comuns em arquivos semelhantes.
3. Além dos Linters: Verificar Padrões
Foco em problemas de estilo que ferramentas automatizadas frequentemente não detectam:
Consistência de Nomeação:
- Variáveis booleanas: prefixos
is,has,should - Manipuladores de eventos: padrões
handle*,on* - Getters/setters: consistência
get*,set* - Nomeação de coleções: plural vs singular
- Siglas: capitalização consistente
Organização de Código:
- Funções relacionadas agrupadas
- Estrutura de arquivos consistente entre módulos
- Ordenação lógica (público antes de privado, etc.)
- Separação de responsabilidades
Comentários e Documentação:
- Completude de JSDoc/docstring
- Consistência de estilo de comentários
- Formato TODO/FIXME
- Comentários em linha vs bloco
Padrões de Importação/Exportação:
- Ordenação de importações (externas, internas, relativas)
- Exportações nomeadas vs padrão
- Consistência de desestruturação
- Padrões de apelidos
Tratamento de Erros:
- Formato de mensagem de erro consistente
- Uso de classes de erro
- Padrões try/catch
- Formato de logging
Uso de Tipos (TypeScript/linguagens tipadas):
- Tipos explícitos vs inferidos
- Preferência por
interfacevstype - Nomeação de genéricos (T, K, V vs descritivo)
- Tratamento de null/undefined
4. Identificar Anti-Padrões Comuns
Sinalize maus cheiros de código e anti-padrões:
Números Mágicos:
// Ruim
if (status === 200) { }
// Bom
const HTTP_OK = 200;
if (status === HTTP_OK) { }
Verificações de null inconsistentes:
// Inconsistente
if (user === null) { }
if (!data) { }
if (typeof result === 'undefined') { }
// Consistente
if (user === null) { }
if (data === null) { }
if (result === undefined) { }
Ternários aninhados:
// Difícil de ler
const valor = a ? b ? c : d : e;
// Melhor
let valor;
if (a) {
valor = b ? c : d;
} else {
valor = e;
}
Listas longas de parâmetros:
# Difícil de manter
def criar_usuario(nome, email, idade, endereco, telefone, ...):
# Melhor
def criar_usuario(dados_usuario: DadosUsuario):
5. Verificar Convenções Específicas do Projeto
Procure por padrões únicos deste projeto:
- Nomeação personalizada para domínios específicos (ex.: "repo" vs "repositorio")
- Bibliotecas preferidas para tarefas comuns
- Padrões arquiteturais (MVC, camada de serviço, etc.)
- Nomeação e estrutura de arquivos de teste
- Padrões de configuração
Leia CONTRIBUTING.md, README.md, ou documentos semelhantes para diretrizes explícitas.
6. Gerar Recomendações de Estilo
Para cada problema, forneça:
Código atual:
function obterDados(id) {
const d = fetch('/api/usuarios/' + id);
return d;
}
Problema:
- Nomeação inconsistente (
obterDadosvs outras funções usambuscar*) - Nome de variável de letra única (
d) - Concatenação de strings em vez de template literals
Recomendado:
function buscarUsuario(id) {
const dadosUsuario = fetch(`/api/usuarios/${id}`);
return dadosUsuario;
}
7. Priorizar Problemas
Ordene por impacto:
Alta Prioridade (Consistência):
- Inconsistências de nomeação entre funções semelhantes
- Indentação ou formatação mista
- Tratamento de erros inconsistente
Média Prioridade (Legibilidade):
- Números/strings mágicas
- Nomes de variáveis pouco claros
- Documentação ausente
Baixa Prioridade (Bom ter):
- Formatação de comentários
- Ordenação de importações
- Linhas em branco extras
8. Sugerir Ferramentas Automatizadas
Recomende ferramentas para aplicar estilos:
JavaScript/TypeScript:
npm install --save-dev prettier eslint
npx prettier --write .
npx eslint --fix .
Python:
pip install black isort flake8
black .
isort .
Go:
go fmt ./...
golangci-lint run
Ruby:
gem install rubocop
rubocop -a
9. Criar ou Atualizar EditorConfig
Sugira .editorconfig se estiver faltando:
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.{js,ts,jsx,tsx}]
indent_style = space
indent_size = 2
[*.py]
indent_style = space
indent_size = 4
[*.go]
indent_style = tab
10. Lista de Verificação de Revisão de Estilo
Ao revisar código para estilo:
- A nomeação segue as convenções do projeto
- Indentação e formatação consistentes
- Importações organizadas corretamente
- Comentários onde necessário, não excessivos
- Sem números ou strings mágicas
- Tratamento de erros consistente
- Organização de arquivos corresponde à estrutura do projeto
- Sem maus cheiros de código óbvios
- Anotações de tipo consistentes (se aplicável)
- Testes seguem as convenções de teste
Melhores Práticas
- Consistência sobre perfeição: Siga padrões existentes mesmo que não sejam ideais
- Documente decisões: Adicione guias de estilo para casos ambíguos
- Automatize quando possível: Use Prettier, Black, gofmt, etc.
- Seja pragmático: Não refatore código funcional apenas por estilo
- Acordo em equipe: Alinhe-se sobre os estilos que importam
- Melhoria incremental: Corrija estilos em arquivos tocados, não todos de uma vez
- Legibilidade primeiro: O estilo serve à legibilidade, não o contrário
Conflitos de Estilo Comuns
Tabs vs Espaços
- Verifique
.editorconfigou arquivos existentes - Em caso de dúvida, use a maioria do projeto
Estilo de Aspas (Simples vs Duplas)
- JavaScript: Simples (
') comum - Python: Qualquer uma, seja consistente
- Go: Sempre duplas (
") - Siga a configuração do linter se presente
Ponto e Vírgula (JavaScript)
- Verifique a maioria do código existente
- Se misturado, sugira o Prettier para aplicar
Comprimento de Linha
- Limites comuns: 80, 100, 120 caracteres
- Verifique a configuração do linter ou
.editorconfig
Ordenação de Importações
- Normalmente: stdlib, externas, internas, relativas
- Use ferramentas automatizadas (isort, organize imports)
Arquivos de Suporte
reference/style-guides.md: Links para guias de estilo popularesexamples/before-after.md: Exemplos de código mostrando melhorias