yireo/magento2-extensionchecker

Scan the code of a Magento module

Installs: 323

Dependents: 0

Suggesters: 0

Stars: 14

Watchers: 1

Forks: 2

Open Issues: 1

Type:magento2-module

1.0.2 2019-06-08 09:20 UTC

README

This extension validates the code of other extensions and is complementary to static code analysis tools like PHPCS.

./bin/magento yireo_extensionchecker:scan Yireo_Example

Installation

Install the module as a composer requirement for developer environments:

composer require --dev yireo/magento2-extensionchecker
./bin/magento module:enable Yireo_ExtensionChecker

Note that if you want to scan a module, this module also needs to be enabled. Personally, we use this extension in our CI/CD chain, to make sure zero issues are reported at all times.

Deprecated dependencies

Class dependencies (injected via the constructor) are inspected to see if they are deprecated, for the used Magento version.

Undeclared dependencies

Class dependencies (injected via the constructor) are traced back to their corresponding module (or the framework or something else), which should be reflected upon in the composer.json file and the module.xml file. Of each composer dependencies, the current version is also reported.

Also, by tokenizing the PHP source, it is detected whether the composer.json file should reflect a specific PHP extension (for example, ext-json) when an extension-specific PHP function is used (for example, json_encode).

@todo: Incorrect versioning for dependencies

When loading dependencies in composer.json, semantic versioning should be used to identify the right release for your dependency (major, minor, patch). A wildcard * is definitely forbidden. Magento dependencies should be in proper format. All dependencies should have major definitions that are not in the future.

@todo: Hard-coded Proxies

A Proxy is a DI trick which should be configured in the di.xml file of a module and not be hard-coded in PHP.