Installation
The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
# Download using curl
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
# Or download using wget
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
# Then test the downloaded PHARs
php phpcs.phar -h
php phpcbf.phar -h
Composer
If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
composer global require "squizlabs/php_codesniffer=*"
Make sure you have the composer bin dir in your PATH. The default value is ~/.composer/vendor/bin/
, but you can check the value that you need to use by running composer global config bin-dir --absolute
.
Or alternatively, include a dependency for squizlabs/php_codesniffer
in your composer.json
file. For example:
{
"require-dev": {
"squizlabs/php_codesniffer": "3.*"
}
}
You will then be able to run PHP_CodeSniffer from the vendor bin directory:
./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h
Install the WCPS:
https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
After setting the WPCS well, if we want to format the code with shortcut key according to WordPress coding standard, we’ll need to follow the instruction below –
- Install the PHPCBF extension.
- Set the phpcbf executable path.
- Set the shortcut key.My user settings are like –
"phpcbf.standard": "WordPress", "phpcbf.executablePath": "~/.composer/vendor/bin/phpcbf", "phpcbf.onsave": true
In need visit – https://github.com/tommcfarlin/phpcs-wpcs-vscode https://wpbeaches.com/set-up-composer-and-phpcodesniffer-on-visual-studio-code-on-macos/