fix: phpstan level 5 errors #84

[Morgy93]

This pull request includes a variety of improvements and refactorings across the codebase, focusing on constructor property promotion, type hinting, and code simplification. The most significant changes are grouped below.

Constructor Property Promotion and Dependency Handling:

• Refactored multiple classes (Inspector, InspectorCommand, InspectorHints, InspectorHints decorator, and BuilderPool) to use PHP's constructor property promotion with private readonly for dependencies, reducing boilerplate and improving immutability. [1] [2] [3] [4] [5]
• Removed unused or unnecessary dependencies from constructors, such as in ThemePath and CompatibilityChecker. [1] [2]

Codebase Simplification and Cleanup:

• Deleted the unused InspectorHintsFactory class, streamlining the template engine decorator logic.
• Improved and simplified logic in several methods, such as removing unnecessary checks and clarifying return types. [1] [2] [3] [4] [5]

Type Hinting and Documentation Improvements:

• Added or refined type hints and docblocks for method parameters and return types, especially in System/CheckCommand.php, enhancing code clarity and IDE support. [1] [2] [3] [4] [5] [6]
• Adjusted PHPStan configuration to lower the analysis level from 6 to 5, likely to accommodate new or legacy code.

Workflow and Build Improvements:

• Updated the GitHub Actions workflow to use composer create-project for Magento installation instead of git clone, improving reliability and mirroring production setups.
• Removed unnecessary steps or parameters from the workflow, such as the continue-on-error flag and redundant module enablement.

Minor Fixes and Consistency:

• Fixed small issues such as the suppression annotation format for PHPMD, and improved logic for handling environment variables and return values. [1] [2] [3] [4]

These changes collectively modernize the codebase, improve maintainability, and enhance type safety.

[Copilot]

Pull request overview

This pull request addresses PHPStan level 5 static analysis errors by refactoring code to use modern PHP 8+ features, improve type safety, and fix type-related issues. The changes focus on constructor property promotion, better type documentation, and removing redundant checks.

Changes:

• Lowered PHPStan level from 6 to 5 and removed continue-on-error from CI workflow to enforce static analysis
• Refactored multiple classes to use PHP 8+ constructor property promotion (readonly properties)
• Improved PHPDoc type annotations and removed redundant type checks

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
phpstan.neon	Lowered PHPStan analysis level from 6 to 5
.github/workflows/phpstan.yml	Changed Magento installation method and removed continue-on-error flag
src/Service/ThemeBuilder/BuilderPool.php	Applied constructor property promotion
src/Service/StaticContentCleaner.php	Simplified return logic to check only cleaned files
src/Service/Hyva/CompatibilityChecker.php	Removed unused IncompatibilityDetector dependency
src/Model/ThemePath.php	Removed unused ThemeList and ThemeCollection dependencies
src/Model/TemplateEngine/Plugin/InspectorHints.php	Applied constructor property promotion and quoted @SuppressWarnings annotation
src/Model/TemplateEngine/Decorator/InspectorHintsFactory.php	Deleted factory class
src/Model/TemplateEngine/Decorator/InspectorHints.php	Applied constructor property promotion, made Random required, added guard clause, improved instanceof checks
src/Console/Command/Theme/TokensCommand.php	Changed return type from int to null for validation methods
src/Console/Command/Theme/CleanCommand.php	Removed redundant is_string check on typed parameter
src/Console/Command/Theme/BuildCommand.php	Removed redundant is_string check on typed parameter
src/Console/Command/System/VersionCommand.php	Removed unused PACKAGE_NAME constant
src/Console/Command/System/CheckCommand.php	Improved PHPDoc type annotations and ini_get handling
src/Console/Command/Dev/InspectorCommand.php	Applied constructor property promotion and removed unreachable default case
src/Block/Inspector.php	Applied constructor property promotion