Run the evaluator tool

This document outlines the process of using the evaluator tool to verify if your project code adheres to Spryker’s standards.

Install the evaluator tool

• Install the evaluator tool in your project by using the composer:

composer require --dev spryker-sdk/evaluator

• Get general information about the tool and see all the commands related to evaluation in the evaluate section:

vendor/bin/evaluator evaluate -h

Run an evaluation

To evaluate your code, run the evaluator in one of the following ways:

• Evaluate the code of all the modules:

vendor/bin/evaluator evaluate

• Evaluate the code of a specific module:

vendor/bin/evaluator evaluate --path=src/path_to_module

Resolve upgradability issues

If the report contains upgradability issues, see Upgradability guidelines to resolve them.