CakePHP Code Sniffer
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" 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
You can run tests with composer. Because of how PHPCS test suites work, there is
additional configuration state in
phpcs that is required.
Once this has been done once, you can use
phpunit --filter CakePHP to run the
tests for the rules in this repository.
If you'd like to contribute to the Code Sniffer, you can fork the project add features and send pull requests.
Releasing CakePHP Code Sniffer
- Create a signed tag
- Write the changelog in the tag commit