# yireo/magento2-theme-override-checker

> N/A

`composer require yireo/magento2-theme-override-checker`

Canonical URL: https://packagento.com/yireo/magento2-theme-override-checker

## At a glance

- **Vendor**: yireo (https://packagento.com/yireo.md)
- **Latest version**: 0.0.5 — released 2024-09-12
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/yireo/magento2-theme-override-checker and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require yireo/magento2-theme-override-checker:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

N/A

## README

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
```bash
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:
```bash
bin/magento yireo:theme-overrides:check Magento/luma

```

List all specific override details for a specific file:
```bash
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:
```bash
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
](https://github.com/AmpersandHQ/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 `contextLines` in 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](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [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

## Recent Versions

| Version | Released |
|---|---|
| 0.0.5 | 2024-09-12 |
| 0.0.4 | 2024-05-08 |
| 0.0.3 | 2023-08-28 |
| 0.0.2 | 2023-08-19 |
| 0.0.1 | 2023-08-16 |

## Dependencies

### Require

| 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 |

## Quality

Latest release (0.0.5) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| 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. Never affect the Compatibility verdict — 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 against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 2 | Unknown | – | – |
| 2.4.8 | – | 2 | 5 | – |
| 2.4.9 | – | – | Error | Error |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit 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 |

#### 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

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["yireo/magento2-theme-override-checker"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

yireo is a Magento 2 vendor on Packagento. See https://packagento.com/yireo.md for their full catalogue.

