zieglerh/php-code-quality

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

v1.0 2024-03-10 20:11 UTC

Requires

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

GPL-3.0-or-later

• Harald Ziegler

README

CLI tools for running PHP code checks and refactoring for Pimcore

• PHP Code Quality Tools
  • Installation
    • Composer
    • Templates
    • Overwrite rulesets
    • Disable tools
  • Execute
    • Code checks
    • Automatic refactoring
  • Configuring rulesets
    • Configuration
    • Rulesets

Installation

Composer

composer require --dev zieglerh/php-code-quality:^1.0

Templates

Copy /templates/* into your project root folder

Overwrite rulesets

In your .env file you can define a path to overwrite the rulesets, e.g. from your project root

PHPCS_RULESET_FILE=./phpcs.xml
PHPMD_RULESET_FILE=./phpmd.xml

Disable tools

You can disable tools in your .env file by setting the following

PHPCS=0
PHPMD=0
PHPSTAN=0

or disable all of them with

CODE_CHECKS_ENABLED=0

Overwrite tool arguments

You can also overwrite tool arguments from definition_args.conf in your .env file

PHPCS_ARGS=...
PHPMD_ARGS=...
PHPSTAN_ARGS=...

Execute

Code checks

vendor/bin/code-check

To execute only specific tools, you can append one or multiple arguments

vendor/bin/code-check phpcs phpmd phpstan

Automatic refactoring

Display automatic code refactoring

vendor/bin/rector process --dry-run

Run rector and change all files

vendor/bin/rector process

Configuring rulesets

Configuration

For configuration of tools see defnitions_tools.conf

Rulesets

Rulesets are defined inside the rulesets/*.xml files and can be overwritten

See Overwrite rulesets