The automation of the process of caring for the quality of the code in PHP and JavaScript | Codesushi - Rzeszow 2016
0 likes193 views
This document discusses tools for automating code quality checks in PHP and JavaScript. It begins with an overview of the history of code quality, from unstructured "spaghetti code" to standardized practices. It then covers generally accepted practices like DRY principles. The document outlines PHP standards like PSR-0/4 and tools like PHP CodeSniffer and PHP Mess Detector. Similar JavaScript standards and tools are covered, including JSLint, JsHint, and ESLint. It emphasizes integrating these tools with editors and continuous integration systems to automatically enforce code quality standards.
Ad
More Related Content
What's hot (20)
Similar to The automation of the process of caring for the quality of the code in PHP and JavaScript | Codesushi - Rzeszow 2016 (20)
Ad
More from Krzysztof (Chris) Ozog (16)
Ad
Recently uploaded (20)
The automation of the process of caring for the quality of the code in PHP and JavaScript | Codesushi - Rzeszow 2016
- 1. The automation of the process of caring for the quality of the code in PHP and JavaScript
- 2. … so how to avoid the following situation: źródło: https://pbs.twimg.com/media/Bp1IyS7CYAATIEB.jpg
- 3. “Two words” about me ● A PHP programmer since 2007. ● CTO at Codesushi since 2013. ● A clean code preacher.
- 4. The plan, so what will this be about ● A bit of history, meaning the origins of the discussed tools. ● An overview of standards and good practices. ● An overview of tools supporting PHP. ● An overview of tools supporting Javascript. ● Taking advantage of tools in a local work environment. ● Taking advantage of tools in the continuous integration process.
- 5. Some history ● The spaghetti code era (~2006) ○ Mainly focused on the execution of projects and not on the quality of the code, ○ Browser wars, “IE only websites”. ● The framework era (2006 ~ 2011) ○ A continuation of the browser wars, ○ The popularization of using frameworks, ○ The beginnings of a systematic html, ○ The birth of jquery, ○ PHP 5.3, ○ A stable version of jshint. ● The era of standardization and good practices (~> 2012) ○ PSR standards, ○ The popularization of nodejs, grunt, gulp, angularjs, ○ An emphasis on the quality of the code.
- 6. Generally accepted good practices ● Do Not Repeat Yourself (DRY). ● S.O.L.I.D. ● Separation of concerns. ● Fat models skinny controllers. ● Object calisthenics.
- 7. An overview of PHP standards ● PSR-0 and PSR-4 ○ Define the functioning of an autoloader, ○ Introduce a unification in the method of organizing the code. ● PSR-1 ○ Unifies code styles on the basic level, ○ Unifies character coding for php source files, ○ Unifies the naming of classes, methods, and variables. ● PSR-2 ○ Unifies the style of the code on a higher level, ○ Unifies the size of the “indentations”, ○ Unifies how if, for, foreach, while constructions should look like.
- 8. An overview of Javascript standards ● Douglas Crockford recommendation (http://javascript.crockford.com/code.html) ● Google JavaScript Style Guide (https://google.github.io/styleguide/javascriptguide.xml)
- 9. An overview of PHP tools ● PHP Code sniffer, ● PHP Mess detector, ● PDepend, ● PHP copy paste detector, ● PHP Coding standards fixer.
- 10. PHP CodeSniffer ● Verifies the code in terms of its accordance with the generally accepted good practices ○ Clean Code (SOLID), ○ Unused code, ○ Verifying the complexity of the code. ● Allows to define own rules. ● Integrates itself with popular editors and programming environments ○ Atom, ○ Sublime Text, ○ PHPStorm. ● Most systems of Continuous Integration include the possibility to run this tool as an element of the process ● It’s good to integrate this tool on the editor level.
- 11. PHP Mess detector ● Verifies the code in terms of its accordance with PSR standards. ● Allows to define own standards. ● Integrates with popular editors and programming environments ○ Atom, ○ Sublime Text, ○ PHPStorm. ● Most systems of Continuous Integration include the possibility to run this tool as an element of the process. ● It’s good to integrate this tool on the editor level.
- 12. PDepend ● Collects data and creates statistics concerning the code. ● Includes a wide array of programming software metrics. ● Most systems of Continuous Integration include the possibility to run this tool as an element of the process. ● This tool will work best as a part of the Continuous Integration process.
- 13. PHP Copy/Paste detector ● Detects a copied code, as suggested by the name. ● Most CI systems support this tool. ● It will work best as an element of the CI process.
- 14. PHP Coding standards fixer ● Allows to automatically adjust the code to PSR standards. ● It is possible to use it in the CI process. ● It will work best as a tool used from time to time when we are dealing with a legacy code.
- 15. An overview of Javascript tools ● JsLint, ● JsHint, ● EsLint.
- 16. An overview of tools for Javascript: JsLint ● Created by Douglas Crockford. ● The first tool to verify the quality of the JS code. ● Does not include configuration options. ● Bases on the set of good practices created by Crockford and named “Javascirpt - the good parts”. ● Popular editors offer integration with this tool. ● Most CI systems support this tool.
- 17. An overview of tools for Javascript: JsHint ● “The successor” of JSLint. ● A more liberal tool. ● There is an option to configure the tool’s behavior. ● A basic support for the new version of JS (ES6). ● Popular editors offer integration with this tool. ● Most CI systems offer support for this tool.
- 18. An overview of tools for Javascript: EsLint ● Close to JsHint. ● Includes the possibility to implement own coding rules and standards. ● There is the option to configure the tool’ behavior. ● Full support for the new version of JS (ES6). ● Popular editors allow to integrate with this tool. ● Most CI systems support this tool.
- 19. Working with Continuous Integration systems (CI) ● All tools listed in this presentation work with CI systems. ● Thanks to a proper configuration of these tools we may force the developers to create a code accordant with our conventions. ● This way we can save the time needed for code review and be sure that errors will be detected.
- 20. Summary ● Both PHP and Javascript don’t prevent creating low quality codes themselves. ● There are tools making it possible to automatically maintain the code’s quality. ● Long-lasting efforts of communities were needed to create these tools. ● Thanks to these tools we can save the time needed for Code Review, and thanks to the integration with Continuous Integration systems we can also be more positive that any errors are going to be detected.