Code Quality

Table of contents

1. Code style
   1. Installing PHPCS
   2. Checking the code style
   3. Composer script
2. PHPCS for WordPress VIP
   1. Installing the ruleset
   2. Checking the code
   3. Checking and exporting the results to CSV
3. Mess detector
   1. Installing PHPMD
   2. Checking the code
   3. Composer script
4. DRY - Don’t repeat yourself
   1. Installing PHPCPD
   2. Checking the code
   3. Composer script

Code style

We use the PSR-12 standard.

Most IDEs or code editors support automatic check for the code style run.

Installing PHPCS

You can install it as a composer dev requirement:

$ composer require --dev squizlabs/php_codesniffer

Checking the code style

For checking the code style we use PHP CodeSniffer.

You can check the code style running:

$ vendor/bin/phpcs --standard=PSR12 ./src-dir any-other-file.php --colors

Composer script

For convenience, add a composer script to your composer.json file:

"scripts": {
    "cs-check": "vendor/bin/phpcs --standard=PSR12 ./src-dir any-other-file.php --colors",
}

Then you can just run:

$ composer cs-check

PHPCS for WordPress VIP

In order to avoid warnings and reports from WordPress VIP sites we should make sure we fixed all the Warnings with security level over 10.

Installing the ruleset

$ composer require --dev automattic/vipwpcs dealerdirect/phpcodesniffer-composer-installer

Checking the code

$ vendor/bin/phpcs --standard=WordPressVIPMinimum ./src
$ vendor/bin/phpcs --standard=WordPress-VIP-Go ./src
$ vendor/bin/phpcs --standard=VariableAnalysis ./src

Don’t run this command in the vendor folder. Maybe it makes sense to create a .phpcs.xml.dist file adding the speciifc files that should be tested.

Checking and exporting the results to CSV

You can use the following command to check and export the results in a CSV format. Run the command from inside the project folder.

$ vendor/bin/phpcs --standard=WordPress-VIP-Go -sp --basepath=. --ignore=vendor ./ --report-file=report.csv --report=csv

Mess detector

We use the PHP Mess Detector as a tool for helping to find potential problems withing the source like:

• Possible bugs
• Suboptimal code
• Overcomplicated expressions
• Unused parameters, methods, properties

Installing PHPMD

You can install as a composer dev requirement

$ composer require --dev phpmd/phpmd

Create a file phpmd-ruleset.xml in the project’s root dir:

<?xml version="1.0"?>
<ruleset name="PublishPress Plugin"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
                       http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="
                       http://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>Custom ruleset for the PublishPress plugin code</description>

    <rule ref="rulesets/codesize.xml"/>
    <rule ref="rulesets/cleancode.xml"/>
    <rule ref="rulesets/controversial.xml"/>
    <rule ref="rulesets/design.xml"/>
    <rule ref="rulesets/naming.xml"/>
    <rule ref="rulesets/unusedcode.xml"/>
</ruleset>

Checking the code

You can use the tool running:

$ vendor/bin/phpmd ./src ansi phpmd-ruleset.xml

Composer script

For convenience, you can create a composer script:

"scripts": {
    "mess-check": "vendor/bin/phpmd ./src ansi phpmd-ruleset.xml"
}

For checking all the source folder you just need to run:

$ composer mess-check

DRY - Don’t repeat yourself

The DRY principle aim to reduce code duplication. Duplicated code can lead to a poor refactoring and poor maintenance.

In order to detect copied, or repeated code, we use PHP Copy/Paste Detector (PHPCPD).

Installing PHPCPD

You can install as a composer dev requirement

$ composer require --dev sebastian/phpcpd

Checking the code

You can use the tool running:

$ vendor/bin/phpcpd ./src

Composer script

For convenience, you can create a composer script:

"scripts": {
    "copy-check": "vendor/bin/phpcpd ./src"
}

For checking all the source folder you just need to run:

$ composer copy-check