Introdução: por que o code review é necessário em TypeScript
Code review (revisão de código) é o processo de verificar o código escrito por outros desenvolvedores. Para desenvolvedores TypeScript iniciantes, isso não é apenas uma formalidade, mas uma poderosa ferramenta de aprendizado. Uma revisão adequada ajuda a identificar erros em estágios iniciais, melhorar a arquitetura e manter um estilo consistente na equipe.
Neste artigo, vamos analisar exatamente no que prestar atenção durante o code review em TypeScript, como dar feedback para que seja útil e fornecer exemplos de código. O material é voltado para iniciantes que estão começando a trabalhar com TypeScript e desejam aprimorar suas habilidades de revisão.
1. Tipagem: a base do TypeScript
A primeira coisa a verificar em TypeScript é a correção dos tipos. O TypeScript adiciona tipagem estática, o que reduz a quantidade de bugs, mas apenas se os tipos forem usados corretamente.
O que verificar:
- Tipos explícitos para parâmetros e valores de retorno. Evite
anysempre que possível. - Uso de interfaces e tipos em vez de primitivos para estruturas complexas.
- Uso correto de tipos Union e Intersection.
- Ausência de conversões de tipo desnecessárias (type assertions).
// Ruim: tipo implícito e anyfunction processData(data: any) { return data.name;}
// Bom: interface explícitainterface User { name: string; age: number;}
function processData(data: User): string { return data.name;}Ao revisar, preste atenção aos lugares onde o tipo any poderia ser substituído por um tipo mais específico. Isso melhora imediatamente a legibilidade e a segurança do código.
2. Verificação de null e undefined
O TypeScript ajuda a evitar erros com null e undefined por meio de strict null checks. Mas os desenvolvedores frequentemente esquecem de tratar valores opcionais.
O que verificar:
- Uso de
?para propriedades e parâmetros opcionais. - Verificação de
nullantes de acessar propriedades. - Uso dos operadores
??e?..
// Ruim: sem proteção contra undefinedfunction getLength(str: string | undefined): number { return str.length; // Erro: str pode ser undefined}
// Bom: usando optional chaining e nullish coalescingfunction getLength(str: string | undefined): number { return str?.length ?? 0;}No code review, verifique se todos os valores potencialmente vazios foram tratados. Essa é uma causa comum de bugs em produção.
3. Limpeza do código e legibilidade
TypeScript é uma extensão do JavaScript, portanto, os princípios de código limpo permanecem relevantes. Um bom code review inclui a verificação do estilo e da estrutura.
O que verificar:
- Nomeação de variáveis e funções. Os nomes devem ser significativos.
- Tamanho das funções. Se uma função faz mais de uma coisa, divida-a.
- Comentários. Eles devem explicar o "porquê", não o "o quê".
- Ausência de números mágicos. Extraia constantes para variáveis separadas.
// Ruim: números mágicos e nome pouco clarofunction calc(a: number) { return a * 1.2;}
// Bom: constante e nome compreensívelconst TAX_RATE = 0.2;
function calculateTotalWithTax(amount: number): number { return amount * (1 + TAX_RATE);}Ao revisar, pergunte-se: "Um novo desenvolvedor conseguiria entender este código sem explicações?" Se não, peça melhorias.
4. Como dar feedback: de forma suave e construtiva
Code review não é um exame, mas um diálogo. Para iniciantes, é especialmente importante receber feedback sem críticas pessoais. Aqui estão algumas regras que ajudam a dar comentários úteis.