ppl / module-dev-tool
Magento 2 admin development hub for search simulation, generated-data cleanup and optional seed-data add-ons.
PPL Dev Tool for Magento 2
PPL Dev Tool provides a development and QA workspace for search simulation, generated-data cleanup, and optional seed-data add-ons.
What It Adds
- Search Term Simulator for realistic Magento query rows
- Cleanup tooling for generated PPL test data
- Shared workspace used by Create Articles, Customers, Orders, Store, Taxes, and Quick Setup
Requirements And Dependencies
- PHP: >=8.1
- Magento packages: magento/framework, magento/module-backend, magento/module-search, magento/module-store
- PPL packages: ppl/module-hub
Installation
Composer installation:
composer require ppl/module-dev-tool
bin/magento module:enable Ppl_Hub Ppl_DevTool
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
Manual app/code installation: copy the module to app/code/Ppl/DevTool, install the dependencies listed above, then run the same Magento commands without the Composer step.
First Use
- Install Ppl_Hub first.
- Open the Dev Tool workspace and run a search simulation or cleanup dry run.
- Install generator add-ons when you need catalog, customer, order, store, tax, or scenario data.
Admin entry: PPL Hub > PPL Dev Tool.
Integrations And Boundaries
- Ppl_DevCreateArticles, Ppl_DevCreateCustomers, Ppl_DevCreateOrders, Ppl_DevCreateStore, Ppl_DevCreateTaxes, and Ppl_DevQuickSetup extend this workspace.
- Intended for development, QA, demo, or disposable staging environments. Do not treat generated data as production merchant data.
Localization
The package includes translation CSV files for 12 locales: de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, ru_RU, tr_TR, zh_CN.
Documentation
- User Guide: docs/USER_GUIDE.md
- Marketplace Long Description: docs/MARKETPLACE_LONG_DESCRIPTION.md
- Screenshot inventory:
docs/images/ppl-dev-tool/in the repository documentation tree
Support
Support contact: [email protected]. Include the module version, Magento version, enabled PPL companion modules, and the relevant admin or storefront screenshot when reporting an issue.
Changelog
1.2.0
- Adapted to the updated PPL Hub: admin navigation, ACL, and menu integration aligned to the PPL Hub 1.2 line
- Minor fixes and stability improvements
1.0.0
- Initial release.
- Simulate realistic search-term activity and clean up generated test data from one admin and CLI workspace.
Requires 8
| Package | Constraint |
|---|---|
| magento/framework | >=103.0.0 <104.0.0 |
| magento/module-backend | >=102.0.0 <103.0.0 |
| magento/module-search | >=101.1.0 <102.0.0 |
| magento/module-store | >=101.1.0 <102.0.0 |
| php | >=8.1 |
| ppl/module-hub | ^1.2 |
| psr/log | ^1.0 || ^2.0 || ^3.0 |
| symfony/console | ^6.4 || ^7.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.
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 | 1 | 1 warning (ruleset: Magento2) |
| PHPMD | Warning | 15 | 15 rule violations (MissingImport:5, CyclomaticComplexity:2, NPathComplexity:2, ExcessiveMethodLength:2, ExcessiveClassLength:1) |
| Cpd | Pass | 0 | |
| 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.
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 Pawel Pliousnin Digital Solutions
View vendorPPL Dev Tool add-on for creating repeatable Magento 2 development tax classes, rates and rules.
PPL Dev Tool add-on for creating repeatable Magento 2 development store setup data and configuration.
PPL Dev Tool add-on for generating repeatable Magento 2 seed orders for reports, QA and demos.
PPL Dev Tool add-on for generating repeatable Magento 2 seed customers for QA, demos and checkout testing.
Turn 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.