This document discusses code quality and defines the three Cs of code quality - clarity, complexity, and coverage. It explains that clarity means code is well formatted, cohesive, and has descriptive naming. Complexity is measured using cyclomatic complexity to identify tightly coupled code and methods with excessive logic. Coverage shows untested parts of an application but does not guarantee quality. The document emphasizes setting standards, integrating them into workflows using tools like Code Climate, Hound CI, and Codecov, and enforcing standards through linting and breaking builds on failures.

1. ENTERPRISE NODE
CODE QUALITY

2. ABOUT ME
Tech Lead @ MLS
Medium: @kurtiskemple
Twitter: @kurtiskemple
GitHub: @kkemple

3. 3
REPO FOR THIS WEBINAR
KKEMPLE/AWESOME-ENTERPRISE-WEB-SERVICE

4. WHY IS CODE QUALITY IMPORTANT?

5. BENEFITS
• Prevents Entropy
• Improves Velocity
• Increases Developer Morale

6. WHAT DEFINES QUALITY CODE?

7. THE THREE Cs OF CODE QUALITY
• Clarity
• Complexity
• Coverage

8. CLARITY

10. WHAT DOES CLARITY MEAN?
• Code Is Formatted Well
• Code Is Cohesive (Things that belong together are together)
• Variable and Function Names Give Context

11. COMPLEXITY

12. “Cyclomatic complexity is a software metric (measurement),
used to indicate the complexity of a program. It is a
quantitative measure of the number of linearly independent
paths through a program's source code.”

13. http://blog.codeclimate.com/blog/2013/12/12/the-roots-of-
static-analysis/

14. WHY IS MEASURING COMPLEXITY
IMPORTANT?
• It identifies tightly coupled sections of your application
• It identifies methods that might not be clear due to excessive
logic
• It helps identify trends (developer fatigue, tech-debt, etc…)

15. COVERAGE

16. COVERAGE !== QUALITY
It’s important to note that a high coverage score is not
equivalent to a quality test suite. However, it does show
parts of your application that have no tests.

17. WHY IS COVERAGE IMPORTANT?
• It identifies areas of the application that are not tested
• It identifies trends in test/code addition ratios
• It helps instill confidence in the application

18. SETTING STANDARDS

19. BIKESHEDDING
or Parkinson’s Law of Triviality…
https://en.wikipedia.org/wiki/Law_of_triviality

20. PICKING A STANDARD

21. ENFORCING THE STANDARD
• Linting should be run during development (editor plugins,
watching files, etc)
• Linting should break your build when it fails!
• Broken builds should never be merged!

22. INTEGRATING STANDARDS INTO
YOUR WORKFLOW

23. CODE CLIMATE

24. HOUND CI

25. CODECOV

26. Q&A

27. • Enterprise Node.js - Code Quality
https://www.crowdcast.io/e/enterprise-node-1
• Enterprise Node.js - Code Discovery
https://www.crowdcast.io/e/enterprise-node-2
• Enterprise Node.js - Securing Your Environment
https://www.crowdcast.io/e/enterprise-node-3
• Enterprise Node.js - Deploying with Docker
https://www.crowdcast.io/e/enterprise-node-4
27
ENTERPRISE NODE.JS

28. JavaScript is replacing Java, Ruby, and .NET as the technology of choice for
companies that want to build enterprise software faster, and with fewer
resources. Learn about enterprise JavaScript applications at every level of the
stack. As well as how to secure, integrate, test, store, monitor, and deploy
them.
O’REILLY SOFTWARE ARCHITECTURE
CONFERENCE
Architecting For Enterprise in Node.js