Repository with all coding standard ruleset for Zend Framework repositories.
-
Install the module via composer by running:
$ composer require --dev zendframework/zend-coding-standard
-
Add composer scripts into your
composer.json
:"scripts": { "cs-check": "phpcs", "cs-fix": "phpcbf" }
-
Create file
phpcs.xml
on base path of your repository with content:<?xml version="1.0"?> <ruleset name="Zend Framework Coding Standard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> <rule ref="./vendor/zendframework/zend-coding-standard/ruleset.xml"/> <!-- Paths to check --> <file>config</file> <file>src</file> <file>test</file> </ruleset>
You can add or exclude some locations in that file. For a reference please see: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
-
To run checks only:
$ composer cs-check
-
To automatically fix many CS issues:
$ composer cs-fix