Downloaded 18 times
Uploaded byJarrod Overson
Maintainability SFJS Sept 4 2014
The document discusses achieving maintainability in code through examining code quality with linters, generating visual reports on metrics like complexity and coverage, and automating processes like builds, linting, and testing through tools like Grunt and Gulp. It emphasizes setting limits on metrics like complexity, enforcing code style through automation, and treating documentation as important as code.
More Related Content
Similar to Maintainability SFJS Sept 4 2014
Maintainability SFJS Sept 4 2014
- 1. Achieving Maintainability JarrodOverson - @jsoverson
- 2. a . k. a .
- 3.
- 6. ( psst, we’reall idiots )
- 7. We do stufflike… ❯ pi 3.141592653589793 ❯ pi(2) 6.283185307179586
- 8. Or… ❯ 4..days 345600000 ❯ 60..seconds 60000
- 9. And even… <scriptsrc="#"></script>
- 10. What was cleversix months ago
- 11.
- 12. We’re not awfulpeople
- 13.
- 14. smart We’re justlazy
- 15. We’re just smart lazy bored
- 16. We’re just smart lazy bored evil
- 17. We’re just doingour job
- 18. And our jobis hard
- 19. How do weget better at it?
- 20.
- 22. How much analysisdo you run on your code?
- 23.
- 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’SOPTIONS
- 26. SET LIMITS "maxparams": 4 "maxdepth" : 4 "maxstatements" : 20 "maxlen" : 100 "maxcomplexity" : 7
- 27. WHAT IS CYCLOMATICCOMPLEXITY?
- 28. TECHNICALLY CYCLOMATIC COMPLEXITY IS THE NUMBER OF PATHS THROUGH YOUR CODE
- 29. PRACTICALLY CYCLOMATIC COMPLEXITY IS HOW HARD YOUR CODE IS TO TEST
- 30. COMPLEXITY : 1 ! function main(a) { ! }
- 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.
- 39. code coverage istanbul blanket jscover
- 41. plato complexity linterrors maintainability
- 42. MAINTAINABILITY? fn(averageEffort, averageComplexity,averageLines); fn(difficulty, volume) fn(length, vocabulary) fn(uniqueOperators, totalOperands, uniqueOperands) fn(totalOperators, totalOperands) fn(uniqueOperators, uniqueOperands)
- 43. doc coverage this doesn’t exist
- 44.
- 46. IF IT’S NOTEASY It won’t get done.
- 47. IF IT’S NOTAUTOMATIC It won’t get done every time.
- 48. IF IT’S NOTVISIBLE It may as well not be done at all.
- 49. Build first Beforeyou write code, set up your build
- 50. But I don’twanna!
- 51. Look into yeoman Manages file copies, conflicts, prompts, defaults
- 52. But I don’twant to learn Yeoman!
- 53. $ npm installyo generator-generator ! $ mkdir generator-myWorkflow ! $ cd generator-myWorkflow ! $ yo generator
- 55. But I don’tneed all that!
- 57. Delete, add, andmodify It’s surprisingly easy.
- 58. Grunt vs Gulp it doesn’t matter, just choose one.
- 59. What about… •MAKE • RAKE • JAKE • ANT • BROCCOLI • blahhhh…
- 60. It doesn’t matter. Just choose one. ( but be ready to support it )
- 61. Want code coverage? grunt-contrib-jasmine grunt-mocha-istanbul grunt-jscoverage and 30 more
- 62. Want linting? grunt-contrib-jshint grunt-eslint grunt-jscs-checker and 50 more
- 63. Want docs? grunt-contrib-yuidoc grunt-jsdoc grunt-docco and 90+ more
- 64. There’s no excuse for manual process
- 65. 1 2 3PROTECT
- 67. ‣ 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
- 68. Your automation choiceneeds to accommodate enforcement
- 71. Recap your analysis your enforcement your everything Automate Automate Automate
- 72. Interested in whya security hardware startup attracted so many JavaScript developers? Come talk to us! esprima venus plato grunt-contrib
- 73. Achieving Maintainability JarrodOverson - @jsoverson