plank/wp-phpcs-composer

dev-master 2024-02-27 16:07 UTC

Requires

• dealerdirect/phpcodesniffer-composer-installer: *
• phpcompatibility/phpcompatibility-wp: ^2
• squizlabs/php_codesniffer: ^3.4.0
• wp-coding-standards/wpcs: *

MIT

• Dave Kellam

README

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

Installation

Install the library via Composer:

$ composer require --dev plank/wp-phpcs-composer:master

That's it!

Usage

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

Continuous Integration

PHPCS Configuration plays nicely with Continuous Integration solutions. Out of the box, the library loads the Plank-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 Plank-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="Plank-Default" />
</ruleset>