A talk explaining how to define `good code`. Using `Code Complete` as a reference to guide over the quality definition and introducing Linters (each category) for Golang.

1. Analysing code quality
Linters and Static Analysis

2. Hello!
Weverton Timoteo
@wevtimoteo

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

4. How Do You Define
“Good Code” ?

5. maintainability?

6. Efficiency Modularity Elegance
What's the first thing that comes to your
mind?
Proper design
decision

7. Error rate
Comprehensibility
Reviewability
- Code Complete, Steve McConnelDebugging
External quality
Modifiability
Development time
You write readable code because it helps
other people to read your code
“

8. Simplicity
is it about the number of lines?

9. Readability
comments, conventions, naming

10. Modularity
its all about reusability

11. Layering
attention to the boundaries of each layer

12. Design
plan before build

13. Efficiency
too many connections?

14. Elegance
solve problems with proper solutions

15. Clarity
do you really know what you have to do?

16. Balance

17. is a tool that analyzes source code to flag
programming errors, bugs, stylistic errors,
and suspicious constructs
- Wikipedia
What is a linter?
“

18. ● gofmt - Must have for every project
● goimports - Additionally to gofmt, checks unused imports
● unindent - Report code that is unnecessarily indented
Code Formatting

19. gofmt -s (Simplify)

20. goimports

21. ● abcgo - ABC metrics for Go source code.
● gocyclo - Computes and checks the cyclomatic
complexity of functions.
● splint - It finds any functions that are too long or have too
many parameters or results.
Code Complexity

22. ABC Metrics - Calculate Score
● Assignment count when:
=, *=, /=, %=, +=, <<=, >>=,
&=, ^=
++, --
● Branch count when:
Function call
● Condition count when:
<, >, <=, >=, ==, !=
else, case

23. ABC Metrics (abcgo)

24. ● GoLint - Golint is a linter for Go source code
● go-namecheck - helps you to maintain variable/field
naming conventions inside your project
● revive - Drop-in replacement of golint
● lll - Line length linter, used to enforce line length in files
Style and Patterns Checking

25. golint

26. Revive

27. ● govet - checks correctness
● badtime - Badtime is a Golang linter that detects
inappropriate usage of the time.Time struct.
● safesql - Static analysis tool for Golang that protects
against SQL injections.
Bugs

28. govet

29. curiosity “time”
Mon Jan 2 15:04:05 MST 2006
which is Unix time 1136239445 and Since MST is GMT-0700
01/02 03:04:05PM '06 -0700
1234567

30. ● Performance
● Unused code
● Reports
● Outdated packages
● Code without tests (no coverage)
● Magic number detector
What else?

31. Thanks!Any questions?
Which linters are you using?
Tell me! @wevtimoteo
<we’re hiring>

32. References
● Code Complete: A Practical Handbook of Software Construction
● Effective Go
● golang/lint Repository
● Ebert: the code review assistant for your organization
● Awesome Go Linters