yireo / magento2-theme-override-checker
yireo/magento2-theme-override-checker
N/A
Yireo ThemeOverrideChecker
Magento module to find all files of a given Magento theme (for example Magento/luma), compare the found files with the parent theme (and/or modules) and return whether there are differences or not.
Current status: Beta, ready for trying out
Installation
composer require yireo/magento2-theme-override-checker:@dev
bin/magento module:enable Yireo_ThemeOverrideChecker
Usage
List all possible overrides, with a warning for unneeded overrides (with no changes) and a red warning when lines are different:
bin/magento yireo:theme-overrides:check Magento/luma
List all specific override details for a specific file:
bin/magento yireo:theme-overrides:show Magento/luma web/jquery.js
bin/magento yireo:theme-overrides:show Magento/blank web/css/source/_theme.less
List a diff between the current version and the parent theme version:
bin/magento yireo:theme-overrides:diff Magento/luma web/css/source/_theme.less
FAQ
How does this work?
AmpersandHQ developed an excellent tool ampersand-magento2-upgrade-patch-helper
to check the status of a current project. Part of this is that it also scans for override files in the theme. However, it does not report what overriding files actually means. For instance, is overriding an XML layout file good or bad? How many lines of overriding a JavaScript file classifies as a bad practice?
Todo
- Support for multiple parent themes
- Make
contextLinesin DifferGenerator configurable - Improve adviser
- An XML layout file with dozens of line differences is ok
- An XML override file is dangerous
- An PHTML / JS / CSS file with dozens of line differences is dangerous
- Markdown and text files can be the same
- SVG files can be totally different
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.
[Unreleased]
[0.0.5] - 12 September 2024
Fixed
- PHPStan fixes
[0.0.4] - 8 May 2024
Fixed
- Add a command option to filter on file extension #3 @akosglue
[0.0.3] - 28 August 2023
Fixed
- Remove old imports and unused
$finder
[0.0.2] - 19 August 2023
Added
- Improved advices
- Add better styling
- Lowered requirements for
sebastian/diff(Magento 2.3)
[0.0.1] - 2 August 2023
Added
- Initial release
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 0.0.5 | stable | Fail | Partially compatible Details | 2024-09-12 12:39:27 |
| 0.0.4 | stable | Not tested | Not yet tested Details | 2024-05-08 17:55:42 |
| 0.0.3 | stable | Not tested | Not yet tested Details | 2023-08-28 10:40:18 |
| 0.0.2 | stable | Not tested | Not yet tested Details | 2023-08-19 07:46:35 |
| 0.0.1 | stable | Not tested | Not yet tested Details | 2023-08-16 12:18:44 |
Requires 4
| Package | Constraint |
|---|---|
| ext-dom | * |
| magento/framework | ^101.0.1|^101.1|^102.0|^103.0 |
| sebastian/diff | ^1.0 || ^2.0 || ^3.0 || ^4.0 || ^5.0 |
| symfony/finder | ^4.0 || ^5.0 || ^6.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | Pass | ||
| 2.4.8 | not tested | not tested | ||
| 2.4.9 | not tested | not tested |
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 47 | 47 warnings (ruleset: Magento2) — 3 auto-fixable with phpcbf |
| PHPMD | Warning | 7 | 7 rule violations (EmptyCatchBlock:4, ExcessiveMethodLength:1, NPathComplexity:1, UnusedPrivateMethod:1) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 35 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from yireo
View vendorTurn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.