magento-ecg/magniffer

An extendable, XPath driven, static code analysis tool for Magento, built on the top of PHP-Parser library.

1.0 2015-03-23 01:13 UTC

Requires

• php: >=5.4
• nikic/php-parser: 1.0.*@dev
• symfony/console: 2.7.*@dev
• symfony/finder: 2.6.*@dev
• symfony/yaml: 2.7.*@dev

MIT

• Magento Expert Consulting Group

README

An extendable, XPath driven, static code analysis tool for Magento, built on the top of PHP-Parser library.

List of Detected Issues

• SQL Queries Within a Loop
• Not Limiting Collection Load Result
• Empty Class
• Empty Method
• Expression is Always True
• Empty Password in Configuration File
• Handling Overly Broad Event
• Use of Global Event
• Configuration Not in adminhtml.xml.

Installation

With Composer:

composer require --dev magento-ecg/magniffer

Basic Usage

$ php ./vendor/bin/mgf /path/to/files

Extending

It's easy to create a custom inspection by declaring a message, xpath and inspector in YAML file. For example:

message   : Empty Class
xpath     : //node:Stmt_Class[count(subNode:stmts/scalar:array/*) = 0]/subNode:name/scalar:string
inspector : php