Managing Code Quality and Code Consistency

Presented on December 16 2022 for final year Composer Science students at De Montfort University, Leicester, UK.
---------------------------------------------------------------

Transcript

1. Managing Code Quality and Code Consistency Juliette Reinders Folmer
2. “ Only half of programming is coding. The other 90% is debugging.
3. hotblack
4. Functional Technical Architectural Conceptual
5. Importance Conceptual Architectural Functional Technical
6. Attention Conceptual Architectural Functional Technical
7. Pull request Merged ... typo in documentation ... ... whitespace ... ... please add some tests ... ... is situation x handled ... ... use early return ... ... using PHP 8.0 syntax ... ... use strict checking in your tests ...
8. Pull request Merged ... please add some tests ... ... is situation x handled ...
9. Marnhe du Plooy
10. Psalm CS- Fixer PHP Stan PHP CS Exakat PHP CPD PHP Insights PHP MD Phan Rector PHP DCD Static Analysis Tools PHP MND
11. PHP CS Static Analysis Tools
12. Jon Ng Getting Started with PHP_CodeSniffer
13. Phar Composer Git clone PEAR Installation
14. Running PHP_CodeSniffer phpcs /path/to/code –-standard=StandardName -p (show progress) -s (show source/errorcodes) -l (local, do not recurse into subdirs) -n (no warnings) -vvv (verbosity) -i (show installed standards) -h (help, shows lots more options)
15. Fixing errors phpcs /path/to/code –-standard=StandardName phpcbf /path/to/code –-standard=StandardName
16. Which Standard Will Be Used ? Command line .phpcs.xml phpcs.xml .phpcs.xml.dist phpcs.xml.dist --standard=Standard --standard=myrules.xml
17. Standard: ruleset.xml .phpcs.xml.dist • Can add new sniffs • Can be used by name when registered with PHPCS
18. Brief (Re-)Introduction to PHP_CodeSniffer Nightsabre
19. How It Works Standard (ruleset) Sniffs Checks (errorcodes)
20. Standard Standard A Standard B Standard A Standard B Standard A Standard B
21. Standard.Subset.Sniff.ErrorCode Include: <rule ref="…" /> Exclude: <exclude name="…" /> ~~~~~~~~
22. <?xml version="1.0"?> <ruleset name="MyProject"> <file>.</file> <exclude-pattern>*/vendor/*</exclude-pattern> <rule ref="Stnd"/> <rule ref="Stnd.Category"/> <rule ref="Stnd.Category.SniffName"/> <rule ref="Stnd.Category.SniffName.ErrorCode"/> <rule ref="Stnd"/> <exclude name="Stnd.Category.SniffName"/> </rule> <rule ref="Stnd.Category.SniffName"/> <exclude-pattern>*/tests/*</exclude-pattern> </rule> </ruleset> Standard A Standard B
23. Customizing Sniffs <?xml version="1.0"?> <ruleset name="MyProject"> <rule ref="Stnd.Category.SniffName"> <properties> <property name="propertyA" value="true"/> <property name="propertyB" value="100"/> <property name="propertyC" type="array"> <element key="key1" value="value1"/> <element key="key2" value="value2"/> </property> </properties> </rule> </ruleset>
24. <?xml version="1.0"?> <ruleset name="MyProject"> <file>.</file> <arg value="ps"/> <arg name="report" value="summary"/> <arg name="extensions" value="php,inc,js,css,lib/php"/> <ini name="memory_limit" value="128M" /> <arg name="parallel" value="8"/> </ruleset> phpcs . -p –s --report=summary --extensions= php,inc,js,css,lib/php -d memory_limit=128M --parallel=8 (PHPCS 3+)
25. elvis santana Choose Your Poison
27. JS CSS PHP (+ inc)
28. Code Style Documentation Code Smells Code Metrics Best Practices Code Compatibility
29. PHPCS Build-in Standards PEAR PSR1 PSR2 Zend MySource Squiz PSR12 Generic
30. Framework/CMS Standards Laravel Joomla Symfony2 CodeIgniter4 Drupal Magento WordPress MediaWiki Zend Framework (WebImpress) TYPO3 Yii CakePHP
31. Functional Standards and Sniff Collections Object Calisthenics Variable Analysis Universal Slevomat Cognitive Complexity PHP Compatibility Import Detection Security Audit Normalized Arrays PHPCSExtra
32. Recognizing External Standards jeltovski
33. Registering External Standards [1] phpcs --config-set installed_paths /path/to/dir/above/standard phpcs --config-show phpcs --config-set installed_paths /path/to/dir/above/standard1,/path/to/dir/above/standard2
34. Registering External Standards [2] composer require –-dev dealerdirect/phpcodesniffer-composer-installer
35. Tips and Tricks kenbrasier
36. Explain
37. phpcs --standard=PSR12 --generator=Text (Markdown|HTML)
38. Seemann
39. Report Types diff code svnblame gitblame emacs xml checkstyle source full summary info csv json junit
40. Interactive Mode
41. --filter=GitModified --filter=GitStaged
42. Boni Idem Ignoring Issues
43. Handling Rule Exceptions // phpcs:ignore Stnd.Cat.Sniff.ErrorCode <code line to be ignored> // phpcs:disable StndA,StndB.Cat.Sniff -- for reasons ... <code> ... // phpcs:enable // phpcs:ignoreFile
44. --ignore-annotations
45. Maintaining PHP_CodeSniffer and Standards
46. Typical Tasks Coaching New Features PHP+ CI/QA
47. Keeping up with PHP ❑ Fix deprecation notices & errors (runtime compatible) ❑ Add support for new syntaxes to the PHPCS Tokenizer (PHP 5.4+) ❑ Add support to utility functions ❑ Update existing sniffs to support new features (feature compatible) ❑ Create new sniffs related to new features
48. Architecture of External Standards PHP_CodeSniffer PHPCSUtils PHPCompatibility PHPCSExtra WordPressCS ??
49. Links ✓ PHP_CodeSniffer https://github.com/squizlabs/PHP_CodeSniffer ✓ Find External Standards on Packagist https://packagist.org/?query=phpcs&type=phpcodesniffer-standard https://packagist.org/?query=php_codesniffer&type=phpcodesniffer-standard ✓ DealerDirect Composer PHPCS plugin https://github.com/PHPCSStandards/composer-installer ✓ PHPCSDevTools, PHPCSUtils, PHPCSExtra, PHPCompatibility et al https://github.com/PHPCSStandards https://github.com/PHPCompatibility
50. Thanks! Slides: https://speakerdeck.com/jrf Follow me: https://twitter.com/jrf_nl https://phpc.social/@jrf_nl https://github.com/jrfnl