mds-agenturgruppe/php-code-checker

CLI tool for running PHP 8.x for Pimcore 11 code checks

v3.2.0 2024-01-10 13:05 UTC

Requires

• phpmd/phpmd: 2.13.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-symfony: ^1.3
• squizlabs/php_codesniffer: ^3.6
• symplify/phpstan-rules: ^12.4

GPL-3.0-or-later

README

mds-code-check is a CLI tool for running PHP 8.x code checks for Pimcore 11 and Symfony 6 with configurable rule sets with:

• PHPStan
  • PHPStan Symfony Framework
  • PHPStan Rules
• PHP_CodeSniffer
• PHPMD

Installation

composer require --dev mds-agenturgruppe/php-code-checker:^3.0

Getting Started

After successfully installation run this command:

vendor/bin/mds-code-check

This will execute code checks with the default ruleset, which is intended for code checks of Pimcore 11 projects.

Configuring rule sets

Rule sets

Rule sets define which checks and the arguments are used for a project when running the mds-code-check script. By default rulesets/pimcore11/ruleset.conf is used.

Configuration variables

Ruleset files define variables to configure the executed checks.

• Enable (1) or disable (0) checks:
  • PHPSTAN, PHPCS, PHPMD
• Arguments for each check:
  • PHPSTAN_ARGS, PHPCS_ARGS, PHPMD_ARGS

Project configuration

mds-code-check can be adapted to project specific needs.

Used ruleset

The used ruleset is configured by placing .mds-code-checker.conf into the project root folder defining the RULESET variable with the ruleset file to use.

RULESET="./vendor/mds-agenturgruppe/php-code-checker/rulesets/pimcore11/ruleset.conf";

Adapting ruleset

In the project configuration file .mds-code-checker.conf the used ruleset can be adjusted as needed by overwriting the defining variables.

Example for disabling checks and changing arguments:

RULESET="./vendor/mds-agenturgruppe/php-code-checker/rulesets/pimcore11/ruleset.conf";
PHPSTAN_ARGS="--level=9 analyse bundles"
PHPCS_ARGS="--extensions=php --standard=./src/project-phpcs-ruleset.xml ./src -s"
PHPMD_ARGS="./src text --standard=./src/project-phpmp-ruleset.xml --exclude=\"*/Resources/views/*\""

mds-code-check arguments

In development or analysis process it is sometimes useful to only execute some tests. This can be achieved by passing check names as arguments to mds-code-check.

Only execute phpstan:

vendor/bin/mds-code-check phpstan

Only execute PHP_CodeSniffer and phpmd:

vendor/bin/mds-code-check phpcs phpmd

CI pipeline integration

For usage in CI pipelines and failing code check stages mds-code-check returns exit code 1 if at least one of the executed check script returns exit code 1. If all checks are successful exit code 0 is returned.