hanaboso/php-check-utils

Utils for php development - CodeSniffer, PhpStan, PhpUnit, PhpStorm

1.6.4 2024-06-19 16:47 UTC

Requires

• php: ^8.3
• ext-apcu: *
• ext-json: *
• ext-pcov: *
• brianium/paratest: ^7.5
• dg/bypass-finals: ^1.7
• ergebnis/composer-normalize: ^2.43
• ergebnis/phpstan-rules: ^2.2
• php-mock/php-mock-phpunit: ^2.10
• phpstan/phpstan: ^1.11
• phpstan/phpstan-doctrine: ^1.4
• phpstan/phpstan-phpunit: ^1.4
• phpstan/phpstan-strict-rules: ^1.6
• phpstan/phpstan-symfony: ^1.4
• phpunit/phpunit: ^11.2
• slevomat/coding-standard: ^8.15
• spaze/phpstan-disallowed-calls: ^3.4
• squizlabs/php_codesniffer: ^3.10
• symfony/browser-kit: ^7.1
• symfony/framework-bundle: ^7.1
• symfony/security-core: ^7.1

Requires (Dev)

• doctrine/mongodb-odm: ^2.8
• doctrine/orm: ^3.2
• friendsoftwig/twigcs: ^6.4
• phpstan/phpstan-nette: ^1.3

Suggests

• apitte/core: Install me, if you need to use ControllerTestTrait in Nette.
• doctrine/mongodb-odm: Install me, if you using MongoDB.
• doctrine/orm: Install me, if you using MySQL.
• friendsoftwig/twigcs: Install me, if you want to check Twig CodeStyle.
• phpstan/phpstan-nette: Install me, for enable PHPStan for Nette.

MIT

• Hanaboso s.r.o.
• Radek Jirsa
• Radek Brůha

README

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