Talk apresentada no evento Devs Cansados (https://evento2020.devscansados.com.br/) no dia 12/11/20. Nessa talk falo um pouco o que é qualidade de código, métricas interessante para sua base de código.

2. Queria saber a qualidade do
meu código: o que olho?

3. Olá!
Weverton Timoteo
@wevtimoteo

4. “
Any fool can write code that a
computer can understand.
Good programmers write code that
humans can understand.
– Martin Fowler

5. Como você define
um “bom código”?

7. manutenabilidade?

8. Qual a primeira coisa que
vêm à sua mente?

10. Eficiência Modularidade ElegânciaDecisão de Design
apropriada

11. You write readable code because it helps
other people to read your code“
Code Complete, Steve McConnell
Error rate
Comprehensibility
Reviewability
Debuggability
Modifiability

12. Mas como atingir
isso?

13. git
push
origin
main
--force
Programação em par
Métricas ABC
Testes Automatizados
Padrõesde
Codificação
Baixo acoplamento
Integração Contínua
Cobertura de Testes
Revisão de código
Rastreabilidade de
Exceções
Monitoramento
Testes de Estresse
Testes de Segurança
Débito Técnico

14. CALMA!

15. Vamos começar do básico

16. ● Como você se comunica com
seu time?
● Você revisa seu próprio
Pull/Merge Request?
Revisão de Código

17. Testes Automatizados

18. Serviços de “Integração Contínua”
● Os testes automatizados são
executados a cada “push”?
● Como está o build da sua
app?

19. Padrões de codificação
Abertura de
chaves na linha
de cima
Abertura de
chaves na mesma
linha

21. ● Os seus testes exercitam o
código implementado?
● Ter cobertura acima de 90%
significa algo?
Cobertura de Testes
Test Coverage, Martin Fowler

22. Métricas ABC
● Atribuição conta quando:
= *= /= %= += <<=
>>= &= ^= ++ --
● Branch conta quando:
Chamada de função
● Condição conta quando:
< > <= >= == !=
else case

23. ● É um TODO?
TODO
Falta de Coesão nos métodos (LCOM)

24. ● Quantas responsabilidades
uma classe possui
● Getter e setter contam?
● É confiável? Devo utilizar?
Falta de Coesão nos métodos (LCOM)

25. ● Quantos caminhos seu código
pode percorrer?
● Como reduzir a complexidade
ciclomática?
● Como e quando utilizar?
Complexidade Ciclomática

26. is a tool that analyzes source code to flag
programming errors, bugs, stylistic errors,
and suspicious constructs
- Wikipedia
O que é um linter?
“

27. Homoiconicidade
● O código usado para expressar o
programa é escrito usando as
estruturas de dados daquela
linguagem
● Exemplo: Família de linguagens Lisp
(Common Lisp, Scheme) ou Clojure

28. Abstract Syntax Tree (AST)
● Nos diz como as expressões são
representadas
● Representação interna do nosso
código

29. Exemplo de AST

30. ● Complexidade Ciclomática
● Estilo e padrões de Codificação
● Performance
● Trechos de código não-utilizado
● Relatórios
● Pacotes/dependências desatualizadas
● Código sem cobertura de testes
● Detector de números mágicos
O que um Linter pode verificar?

31. Awesome Linters

32. JavaScript

33. Ruby

34. Elixir

35. Golang

36. Python
● pycodestyle (pep8 (Python
Enhancement Proposals))
● pylint

37. PHP

38. Kotlin Swift

39. E se todos checks
passarem?

40. Ainda não cansou?
bit.ly/kitcansado

41. Obrigado!
Vamos analisar a
qualidade do nosso código!

42. Referências
● SourceLevel no Devs Cansados
● Code Complete: A Practical Handbook of Software Construction
● Is High Quality Software Worth the Cost?
● Decoding Code Review and Pull Requests
● 10 items to check before assigning a Pull Request to someone
● Martin Fowler: Test Coverage
● Awesome Linters repository
● JavaScript: ESLint
● JavaScript: Prettier

43. Mais Referências
● JavaScript: JSHint
● Ruby: Brakeman
● Ruby: Reek
● Ruby: Rubocop
● Elixir: Credo
● PHP: PHP Mess Detector
● PHP: phplint
● Golang: golint
● Golang: revive

44. Mais Referências
● Python: Black
● Python: pylint
● Python: pycodestyle
● Swift: swiftlint
● Kotlin: ktlint
● Como medir a coesão do seu código