plank / wp-phpcs-composer
Installs: 17 250
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 12
Forks: 0
Open Issues: 2
Type:phpcodesniffer-standard
This package is auto-updated.
Last update: 2024-11-27 17:56:31 UTC
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>