Download the PHP package cakephp/cakephp-codesniffer without Composer
On this page you can find all versions of the php package cakephp/cakephp-codesniffer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cakephp/cakephp-codesniffer
More information about cakephp/cakephp-codesniffer
Files in cakephp/cakephp-codesniffer
Package cakephp-codesniffer
Short Description CakePHP CodeSniffer Standards
License MIT
Homepage https://cakephp.org
Informations about the package cakephp-codesniffer
CakePHP Code Sniffer
This code works with squizlabs/php_codesniffer and checks code against the coding standards used in CakePHP.
This sniffer package follows PSR-12 completely and ships with a lot of additional fixers on top.
List of included sniffs
Which version should I use?
See version map.
Installation
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 installed_paths
value. Alternatively, install
the dealerdirect/phpcodesniffer-composer-installer
composer package which will handle configuring the phpcs
installed_paths
for you.
Usage
:warning: Warning when these sniffs are installed with composer, ensure that
you have configured the CodeSniffer installed_paths
setting.
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 --colors -p -s --standard=CakePHP /path/to/code/
You can also copy the phpcs.xml.dist
file to your project's root folder as phpcs.xml
.
This file will import the CakePHP Coding Standard. From there you can edit it to
include/exclude as needed. With this file in place, you can run:
vendor/bin/phpcs --colors -p -s /path/to/code/
If you are using Composer to manage your CakePHP project, you can also add the below to your composer.json file:
Running Tests
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.
Contributing
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
All versions of cakephp-codesniffer with dependencies
phpstan/phpdoc-parser Version ^1.4.5
slevomat/coding-standard Version ^8.15
squizlabs/php_codesniffer Version ^3.9