- Install via composer
composer require --dev charonlab/coding-standard
- Create the
phpcs.xml.dist
file in root path of you repository<?xml version="1.0"?> <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"> <arg name="basepath" value="."/> <arg name="cache" value=".phpcs-cache"/> <arg name="colors"/> <arg name="extensions" value="php"/> <arg name="parallel" value="80"/> <!-- Show progress --> <arg value="sp"/> <!-- Paths to check --> <file>src</file> <file>test</file> <!-- Include all rules from the CharonLab Coding Standard --> <rule ref="Charon"/> </ruleset>
- Add composer scripts into your
composer.json
{ "scripts": { "cs": "phpcs", "cs-fix": "phpcbf -vpw" } }
-
To run checks only:
composer run cs
-
To automatically fix violations coding standards:
composer run cs-fix
The MIT License (MIT). Please see License for more information.