Level Up Your Code Quality

Slide 1

Slide 1 text

Level Up Your Code Quality Joel Clermont @jclermont

Slide 2

Slide 2 text

Introduction @jclermont

Slide 3

Slide 3 text

What is code quality? @jclermont

Slide 4

Slide 4 text

Easier to make changes Lower number of defects @jclermont

Slide 5

Slide 5 text

Disclaimer   Don’t do this just because I say so @jclermont

Slide 6

Slide 6 text

Let’s dive in @jclermont

Slide 7

Slide 7 text

This page intentionally left blank @jclermont

Slide 8

Slide 8 text

@jclermont

Slide 9

Slide 9 text

@jclermont

Slide 10

Slide 10 text

Tool 1: PHP linter @jclermont

Slide 11

Slide 11 text

@jclermont https://github.com/overtrue/phplint

Slide 12

Slide 12 text

Getting started https://github.com/overtrue/phplint • Composer install as dev dependency • Ignore .phplint - cache in version control • Setup .phplint.yml con fi guration • What directories to scan • What to ignore, vendor for example • Enable warnings @jclermont

Slide 13

Slide 13 text

@jclermont

Slide 14

Slide 14 text

Summary https://github.com/overtrue/phplint @jclermont Setup e ff ort: Easy Risk: None Impact on quality: Relatively low Recommendation: Install on every project

Slide 15

Slide 15 text

Tool 2: PHP CodeSniffer @jclermont

Slide 16

Slide 16 text

Different philosophies • “Tell me to fi x it” versus “ fi x it for me” @jclermont

Slide 17

Slide 17 text

Different philosophies • “Tell me to fi x it” versus “ fi x it for me” • Local versus remote @jclermont

Slide 18

Slide 18 text

Getting started https://github.com/squizlabs/PHP_CodeSni ff er • Composer install as dev dependency • Pick a standard (I like PSR-12) • Add a few tweaks as needed (slevomat) @jclermont

Slide 19

Slide 19 text

@jclermont

Slide 20

Slide 20 text

@jclermont

Slide 21

Slide 21 text

Your mileage may vary @jclermont

Slide 22

Slide 22 text

Summary https://github.com/squizlabs/PHP_CodeSni ff er @jclermont Setup e ff ort: Easy (if you’re not too opinionated) Risk: Minimal Impact on quality: Higher than you’d expect Recommendation: Install on every project

Slide 23

Slide 23 text

Tool 3: phpcpd @jclermont

Slide 24

Slide 24 text

Summary https://github.com/sebastianbergmann/phpcpd @jclermont Setup e ff ort: Easy Risk: None Impact on quality: Minimal Recommendation: Don’t blindly follow advice

Slide 25

Slide 25 text

Tool 4: phpmd @jclermont

Slide 26

Slide 26 text

Summary https://phpmd.org @jclermont Setup e ff ort: Easy Risk: None Impact on quality: Low Recommendation: Numbers are nice, but aren’t everything

Slide 27

Slide 27 text

Tool 5: PHPUnit @jclermont

Slide 28

Slide 28 text

Test it like you run it prod @jclermont

Slide 29

Slide 29 text

@jclermont

Slide 30

Slide 30 text

@jclermont

Slide 31

Slide 31 text

@jclermont

Slide 32

Slide 32 text

@jclermont

Slide 33

Slide 33 text

@jclermont Infection - mutation testing

Slide 34

Slide 34 text

@jclermont

Slide 35

Slide 35 text

@jclermont

Slide 36

Slide 36 text

Summary https://phpunit.de @jclermont Setup e ff ort: Depends Risk: Writing tests is addictive Impact on quality: To the moon! Recommendation: If you only do one thing, this should be it.

Slide 37

Slide 37 text

Tool 6: PHP Insights @jclermont

Slide 38

Slide 38 text

@jclermont

Slide 39

Slide 39 text

@jclermont

Slide 40

Slide 40 text

@jclermont

Slide 41

Slide 41 text

@jclermont

Slide 42

Slide 42 text

Summary https://phpinsights.com @jclermont Setup e ff ort: Easy Risk: None Impact on quality: Pretty good Recommendation: Scores are nice top-level metric

Slide 43

Slide 43 text

About types in PHP… @jclermont

Slide 44

Slide 44 text

@jclermont

Slide 45

Slide 45 text

@jclermont

Slide 46

Slide 46 text

Tool 7: PHPStan @jclermont

Slide 47

Slide 47 text

But there’s more… @jclermont

Slide 48

Slide 48 text

Getting started https://phpstan.org • So many errors to start • Establish baseline • Pick a level • Rinse and repeat with new versions of PHPStan @jclermont

Slide 49

Slide 49 text

Summary https://phpstan.org @jclermont Setup e ff ort: Medium-to-high Risk: Minimal Impact on quality: Signi fi cant Recommendation: Even better with tests

Slide 50

Slide 50 text

Tool 8: Rector @jclermont

Slide 51

Slide 51 text

How it works @jclermont

Slide 52

Slide 52 text

Summary https://getrector.org @jclermont Setup e ff ort: Prepare for pain Risk: Only your time Impact on quality: Signi fi cant Recommendation: Start with Shift Workbench