 |
VOOZH | about |
|
VOOZH | about |
This document covers the code quality assurance tools integrated into the Auth0 WordPress plugin development workflow. These tools enforce code standards, detect potential bugs through static analysis, and automate refactoring tasks. The focus is on PHPStan, Psalm, PHP-CS-Fixer, and Rector, along with the composite test command that orchestrates all quality checks.
For information about the testing framework (Pest), see Testing Framework. For details about the build process that packages the plugin for distribution, see Build and Packaging.
The plugin integrates four primary code quality tools, each serving a distinct purpose in the development workflow:
| Tool | Purpose | Composer Script |
|---|---|---|
| PHPStan | Static type analysis with strict rules and WordPress-specific checks | composer phpstan |
| Psalm | Alternative static analysis with auto-fixing capabilities | composer psalm |
| PHP-CS-Fixer | Code style enforcement and automatic formatting | composer phpcs |
| Rector | Automated refactoring and code modernization | composer rector |
All tools can be executed together using the composite command: composer test
Sources: composer.json42-59 composer.json97-117
The quality tools are integrated at multiple stages of the development process, from local development through continuous integration:
Sources: composer.json97-117
PHPStan provides static type analysis for PHP code, catching type errors, undefined variables, and incorrect method calls before runtime. The plugin uses PHPStan with strict rules and WordPress-specific extensions.
The plugin includes three PHPStan-related packages:
phpstan/phpstan - Core static analyzerphpstan/phpstan-strict-rules - Additional strict type checking rulesszepeviktor/phpstan-wordpress - WordPress-specific PHPStan extensions for understanding WordPress core functions and hooksThe phpstan script executes: @php vendor/bin/phpstan analyze composer.json105
PHPStan analyzes the src/ directory and reports:
Sources: composer.json51-52 composer.json56 composer.json105
Psalm is an alternative static analysis tool that provides similar functionality to PHPStan but with different heuristics and capabilities. The plugin uses both tools to maximize error detection coverage.
Psalm offers:
The Psalm scripts composer.json106-107:
psalm: @php vendor/bin/psalmpsalm:fix: @php vendor/bin/psalter --issues=allThe psalm:fix command automatically applies fixes for issues that Psalm can resolve, such as adding missing type declarations or correcting incorrect type hints.
Sources: composer.json57 composer.json106-107
PHP-CS-Fixer enforces consistent code style across the codebase by automatically formatting code according to defined rules. This ensures all contributors follow the same coding standards.
The PHP-CS-Fixer scripts composer.json103-104:
phpcs: @php vendor/bin/php-cs-fixer fix --dry-run --diff - Shows what would be changed without modifying filesphpcs:fix: @php vendor/bin/php-cs-fixer fix - Applies formatting changesThe --diff flag displays exactly what changes would be made, making it easy to review style violations before committing.
PHP-CS-Fixer reads its configuration from .php-cs-fixer.php or .php-cs-fixer.dist.php in the project root (not shown in provided files). This configuration defines:
Sources: composer.json46 composer.json103-104
Rector performs automated refactoring and code modernization, enabling safe large-scale code transformations. It can upgrade code to use newer PHP features, apply design patterns, and enforce architectural rules.
The plugin uses Rector version 0.17.0 composer.json54 with a specific pinned version to ensure consistent behavior across environments.
The Rector scripts composer.json108-109:
rector: @php vendor/bin/rector process src --dry-run - Shows potential refactorings without applying themrector:fix: @php vendor/bin/rector process src - Applies refactoring transformationsRector analyzes only the src/ directory, focusing on the plugin's source code rather than vendor dependencies or tests.
Rector can:
Sources: composer.json54 composer.json108-109
The test script provides a single command that executes all quality checks in sequence, providing comprehensive validation:
The composite command runs tools in this order composer.json110-116:
If any tool fails, the remaining checks are not executed. This fail-fast approach ensures developers address issues immediately.
The test command orchestrates all quality assurance checks, making it the primary validation command for CI/CD pipelines and pre-commit hooks.
Sources: composer.json110-116
Each quality tool reads its configuration from dedicated files in the project root:
| Tool | Configuration File | Purpose |
|---|---|---|
| PHPStan | phpstan.neon or phpstan.neon.dist | Analysis rules, ignored paths, WordPress stubs |
| Psalm | psalm.xml or psalm.xml.dist | Error levels, plugin configuration, source paths |
| PHP-CS-Fixer | .php-cs-fixer.php or .php-cs-fixer.dist.php | Coding style rules, file finders |
| Rector | rector.php | Refactoring rules, PHP version targets |
| PHPUnit/Pest | phpunit.xml.dist | Test configuration (see Testing Framework) |
The phpunit.xml.dist file phpunit.xml.dist1-26 defines code coverage reporting and test source directories:
Sources: phpunit.xml.dist1-26
The following diagram shows the development dependencies that provide quality assurance capabilities:
Sources: composer.json42-59
| Command | Script | Dry Run | Purpose |
|---|---|---|---|
composer test | Composite | N/A | Run all quality checks |
composer pest | composer.json99 | No | Execute unit tests |
composer phpstan | composer.json105 | Yes | Analyze with PHPStan |
composer psalm | composer.json106 | Yes | Analyze with Psalm |
composer psalm:fix | composer.json107 | No | Auto-fix Psalm issues |
composer rector | composer.json108 | Yes | Check refactoring |
composer rector:fix | composer.json109 | No | Apply refactoring |
composer phpcs | composer.json103 | Yes | Check code style |
composer phpcs:fix | composer.json104 | No | Fix code style |
All tools can be executed directly via their binaries in vendor/bin/:
Sources: composer.json97-117
The composer test command is designed for continuous integration pipelines. Its fail-fast behavior and comprehensive validation make it suitable for:
The command's zero-configuration execution (all settings in composer.json and dedicated config files) ensures consistent behavior across development, CI, and production environments.
Sources: composer.json110-116
Before committing:
During development:
Before pushing:
composer test to ensure all checks passWhen tools report conflicting issues:
Sources: composer.json110-116
Refresh this wiki