Composer library to provide drop in installation and configuration of WPCS and PHPCompatibilityWP, setting reasonable defaults for WordPress development with nearly zero configuration.
You must add the repository to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/wcvendors/wc-vendors-phpcs.git"
}
]
}
Install the library via Composer:
$ composer require --dev wcvendors/wc-vendors-phpcs:dev-main
Lint your PHP files with the following command:
$ ./vendor/bin/phpcs
If relying on Composer, edit the composer.json
file by adding the following:
"scripts": {
"lint": [
"phpcs"
],
}
Then lint via:
$ composer run lint
PHPCS Configuration plays nicely with Continuous Integration solutions. Out of the box, the library loads the WCVendors-WordPress-Default
ruleset, and checks for syntax errors for PHP 8.0 or higher.
To override the default PHP version check, set the --runtime-set testVersion 7.0-
configuration option. Example for PHP version 7.2 and above:
$ ./vendor/bin/phpcs --runtime-set testVersion 7.2-
See more information about specifying PHP version.
Note that you can only overrule PHP version check from the command-line.
Some IDE integrations of PHPCS fail to register the WCVendors-WordPress-Default
ruleset. In order to rectify this, place .phpcs.xml.dist
at your project root:
<?xml version="1.0"?>
<ruleset name="Project Rules">
<rule ref="WCVendors-WordPress-Default" />
</ruleset>