Skip to content

README.md

Latest commit

 

History

History
53 lines (36 loc) · 1.48 KB

README.md

File metadata and controls

53 lines (36 loc) · 1.48 KB
Raw

DevHelper_CodeScanner

Magento 2

Overview

DevHelper_CodeScanner is a Magento 2 module that helps developers identify bad practices and common issues in custom modules. It provides a CLI command to scan your app/code directory and reports potential problems, making your codebase safer and more maintainable.

What does it detect?

  • Direct usage of ObjectManager
  • Direct instantiation with new (except in tests)
  • Blocks in XML without class or template
  • Observers listening to generic events (e.g., controller_action_predispatch)
  • Plugin before, after, and around methods without return
  • Usage of dangerous PHP functions (eval, exec, shell_exec, system, passthru, proc_open, popen)
  • Debug functions left in code (var_dump, print_r, die, exit)

Installation

  1. Copy the module to app/code/DevHelper/CodeScanner in your Magento 2 project.
  2. Run the following commands in your project root:
php bin/magento setup:upgrade
php bin/magento setup:di:compile
  1. (Optional) Enable the module explicitly:
php bin/magento module:enable DevHelper_CodeScanner

Usage

To scan your custom modules, run:

php bin/magento devhelper:codescan

The command will output a table with the type of issue, module, file, and line number (if available).

Requirements

  • Magento 2.4.x
  • PHP 8.1+

License

MIT or as you prefer.

Maintainer: Rodrigo Cardoso