1) The document discusses achieving maintainability in code through analysis, automation, and enforcement of standards. 2) It recommends setting up linting, code coverage, and other analysis tools to examine code quality and automatically enforcing code style through build processes. 3) The key is to automate as many processes as possible like testing, linting, and documentation to make the code easy to work with and prevent issues from being introduced.

1. Jarrod Overson - @jsoverson
Achieving
Maintainability

2. a. k. a.

3. Idiot proofing your code

6. ( psst, we’re all idiots )

7. We do stuff like…
❯ pi
3.141592653589793
❯ pi(2)
6.283185307179586

8. Or…
❯ 4..Days()
345600000
❯ 60..Seconds()
60000

9. And even…
<script src="#"></script>

10. What was clever six months agoclever

11. Is idiotic todayidiotic

12. We’re not awful people

13. We’re just smart

14. We’re just lazy
smart

15. We’re just
lazy
smart
bored

16. We’re just
lazy
smart
bored
evil

17. We’re just doing our job

18. And our job is hard

19. How do we get better at it?

20. EXAMINE1
2
3

22. How much analysis do you run on your code?

23. It’s not enough.

24. KNOW YOUR LINTERS
JSHINT
ESLINT
JSCS
Community-driven JSLint fork. High configurability.
JSHint alternative. High configurability.
Code style checker. Separate and complementary.
WHAT ABOUT JSLINT AND CLOSURE LINTER?

25. KNOW YOUR LINTER’S OPTIONS

26. "maxparams" : 4
"maxdepth" : 4
"maxstatements" : 20
"maxlen" : 100
"maxcomplexity" : 7
SET NUMERIC LIMITS

27. WHAT IS CYCLOMATIC COMPLEXITY?

28. CYCLOMATIC COMPLEXITY
IS THE NUMBER OF PATHS
THROUGH YOUR CODE
TECHNICALLY

29. CYCLOMATIC COMPLEXITY
IS HOW HARD
YOUR CODE IS TO TEST
PRACTICALLY

30. !
function main(a) {
!
}
COMPLEXITY : 1

31. function main(a) {
if (a > 5) {
}
}
COMPLEXITY : 2

32. function main(a) {
if (a > 5) {
!
} else {
!
}
}
COMPLEXITY : ?

33. function main(a) {
if (a > 10) {
!
} else if(a > 5) {
!
}
}
COMPLEXITY : 3

34. function main(a) {
if (a > 5) {
if (a > 10) {
!
}
}
}
COMPLEXITY : 3

35. function main(a) {
if (a) {
} else if (a) {
}
!
if (other) { }
!
for (var i = 0; i < a; i++) {
if (i % 2) {
} else if (i % 3) {
}
}
}
COMPLEXITY : 7

36. GENERATE VISUAL REPORTS

38. code coverage
istanbul
jscover
blanket

40. plato
complexity
maintainability
lint errors

41. MAINTAINABILITY?
fn(averageEffort, averageComplexity, averageLines);
fn(difficulty, volume)
fn(length, vocabulary)
fn(uniqueOperators, totalOperands, uniqueOperands)
fn(uniqueOperators, uniqueOperands)
fn(totalOperators, totalOperands)

42. doc coverage
this
exist
doesn’t

43. AUTOMATE2
3
1

45. IF IT’S NOT EASY
It won’t be done
IF IT’S NOT AUTOMATED
It will only get done once.
IF IT’S NOT VISUALIZED
It might as well not be done at all

46. Build first
Before you write code, set up your build

47. But that’s annoying!

48. Look into yeoman
Manages file copies, conflicts, prompts, defaults

49. But I don’t want to learn Yeoman!

50. $ npm install yo generator-generator
!
$ mkdir generator-myWorkflow
!
$ cd generator-myWorkflow
!
$ yo generator

52. But I don’t need all that!

54. Delete, add, and modify
It’s surprisingly easy.

55. Grunt VS Gulp
it doesn’t matter, just choose one.

56. What about…
• MAKE
• RAKE
• JAKE
• ANT
• BROCCOLI
• blahhhh…

57. it doesn’t matter
just choose one.
( but be ready to support it )

58. Want code coverage?
grunt-contrib-jasmine
grunt-mocha-istanbul
grunt-jscoverage
and 30 more

59. Want linting?
grunt-contrib-jshint
grunt-eslint
grunt-jscs-checker
and 50 more

60. Want docs?
grunt-contrib-yuidoc
grunt-jsdoc
grunt-docco
and 90+ more

61. There’s no excuse
for manual process

62. PROTECT3
1
2

64. ‣ Code style
‣ Metrics
‣ Build tools
‣ Data formats
‣ Naming conventions
‣ Curly Braces
‣ Directory structure
‣ Everything
ENFORCE
‣ Automate Everything
‣ VCS hooks
‣ CI
‣ Code reviews
‣ Reports
‣ Everything
‣ Warnings === errors
‣ Make it hard to be
wrong
DOCUMENT
‣ Treat docs as code
‣ Make it
‣ easy to find
‣ easy to read
‣ easy to update
‣ easy to discuss
‣ Use github!
AGREE
GET EVERYONE TOGETHER

65. Your automation choice needs to
accommodate enforcement

68. Recap
your analysis
your enforcement
your everything
Automate
Automate
Automate

69. Jarrod Overson - @jsoverson
Achieving
Maintainability