Installs: 14 297

Dependents: 12

Suggesters: 0

Stars: 11

Watchers: 68

Forks: 2

Open Issues: 6


dev-master 2019-03-04 14:40 UTC


Composer library to provide drop in installation and configuration of WPCS and PHPCompatibilityWP, setting reasonable defaults for WordPress development with nearly zero configuration.



Install the library via Composer:

$ composer require --dev 10up/phpcs-composer:dev-master

That's it!


Lint your PHP files with the following command:

$ ./vendor/bin/phpcs .

If relying on Composer, edited the composer.json file by adding the following:

	"scripts": {
		"lint": [
			"phpcs ."

Then lint via:

$ composer run lint

Continuous Integration

PHPCS Configuration plays nicely with Continuous Integration solutions. Out of the box, the library loads the 10up-Default ruleset, and checks for syntax errors for PHP 7 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.

IDE Integration

Some IDE integrations of PHPCS fail to register the 10up-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="10up-Default" />