hanaboso/php-check-utils

Utils for php development - CodeSniffer, PhpStan, PhpStorm

Hanaboso - PHP CHECK UTILS

, _(*1)

Installation

• Download package via composer

composer require --dev hanaboso/php-check-utils

CodeSniffer

• PHP_CodeSniffer docs: https://github.com/squizlabs/PHP_CodeSniffer
• Slevomat Coding Standard docs: https://github.com/slevomat/coding-standard/
• run PHP_CodeSniffer

./vendor/bin/phpcs --standard=./ruleset.xml -p src/ tests/

• ruleset.xml for app

<?xml version="1.0"?>
<ruleset name="HANABOSO CODE STYLE">
    <rule ref="./vendor/hanaboso/php-check-utils/ruleset.xml"/>
    <rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
        <properties>
            <property name="rootNamespaces" type="array" value="
                src=>MyBundle, 
                tests=>Tests 
            "/>
        </properties>
    </rule>
</ruleset>

CodeFixer

• PHP_CodeSniffer docs: https://github.com/squizlabs/PHP_CodeSniffer
• run PHP_CodeSnifferFixer

./vendor/bin/phpcbf --standard=./ruleset.xml -p src/ tests/

PhpStan

• PHPStan docs: https://github.com/phpstan/phpstan
• run PHPStan

./vendor/bin/phpstan analyse -c phpstan.neon -l 8 src/ tests/

• phpstan.neon for app

includes:
    - vendor/hanaboso/php-check-utils/phpstan.neon # hanaboso rules
parameters
    excludes_analyse:
    ignoreErrors:
    symfony:
        container_xml_path: %rootDir%/../../../var/cache/dev/srcDevDebugProjectContainer.xml

CodeCoverage

• run Coverage.sh

./vendor/hanaboso/php-check-utils/bin/coverage.sh 100

PhpStorm - Code Style

• Import code style XML file from ./vendor/hanaboso/php-check-utils/phpstorm.xml to PhpStorm
• Open import window

File -> Settings -> Code Style -> PHP -> Import Scheme -> Intellij IDEA code style XML