This code works with phpcs and checks code against the coding standards used in CakePHP.
master branch contains codesniffer rules that are based on the
PSR2 standard. If you want to check against the historical CakePHP coding
standard use any of the
You should install this codesniffer with composer:
composer require --dev "cakephp/cakephp-codesniffer=2.*" vendor/bin/phpcs --config-set installed_paths /path/to/your/app/vendor/cakephp/cakephp-codesniffer
The second command lets
phpcs know where to find your new sniffs. Ensure that
you do not overwrite any existing
Depending on how you installed the code sniffer changes how you run it. If you have installed phpcs, and this package with PEAR, you can do the following:
vendor/bin/phpcs --standard=CakePHP /path/to/code
Warning when these sniffs are installed with composer, ensure that
you have configured the CodeSniffer
If you'd like to contribute to the Code Sniffer, you can fork the project add features and send pull requests.
Make sure to clone the repository to something like cakephp_codesniffer
(instead of the default cakephp-codesniffer) because otherwise
will fail to run the tests.
Releasing CakePHP Code Sniffer
- Create a signed tag
- Write the changelog in the tag commit