code-quality-audit_skill

Overview

This skill automates a comprehensive code quality audit for Magento 2 projects. It combines PSR-12 compliance checks, PHPStan static analysis, PHP_CodeSniffer with the Magento2 standard, and PHP Mess Detector scans. The result is a prioritized list of issues with concrete remediation guidance and code examples.

How this skill works

The skill runs a sequence of standard tools: a PSR-12 fixer in dry-run mode to surface formatting and style violations, PHPStan at a high strictness level to detect type and signature problems, PHPCS configured for the Magento2 standard to validate framework-specific conventions, and PHPMD to identify complexity, unused code, and design smells. It collects findings from each tool, classifies severity, aggregates by file and line, and generates actionable recommendations and example fixes.

When to use it

• Before submitting code for review to catch style and static-analysis issues early
• After adding new features or modules to validate types and dependencies
• As a gate in pull request pipelines to block regressions and enforce standards
• Before production deployments to reduce runtime errors and maintainability risks
• During continuous integration to keep codebase quality consistent over time

Best practices

• Run the audit locally before opening a PR to reduce back-and-forth feedback
• Fix high and critical severity items first—type errors and undefined methods are priority
• Address PHPMD findings by simplifying complex methods or extracting classes
• Use PSR-12 findings to keep consistent formatting; apply automated fixes where safe
• Keep phpstan configuration tuned for your codebase to reduce false positives

Example use cases

• Validate a new Magento 2 module to ensure it follows Magento coding patterns and DI practices
• Scan a large refactor to find regressions in method signatures or returned types
• Integrate into CI to fail builds when critical or high-severity violations are introduced
• Run before a release to remove unused code, reduce complexity, and improve maintainability
• Provide developers with concrete code examples for correcting style and static-analysis errors