README

evaluator

To run evaluator for the project execute the command

vendor/bin/evaluator evaluate

To run evaluator in particular project directory

vendor/bin/evaluator evaluate --path=some/path

To run evaluator with specific checkers

vendor/bin/evaluator evaluate --checks=<comma separated checkers names>

To run evaluator with specific output format (output by default)

vendor/bin/evaluator evaluate --format=<output, json, compact>

To run evaluator with specific output redirect to project file ./report

vendor/bin/evaluator evaluate --file

Other commands

Generate feature packages breakdown file. Should be executed from the evaluator project only.

GITHUB_AUTH=<token: ghp_*> bin/console extract-feature-packages -vvv

Tooling configuration

Tolling configuration example:

evaluator:
    checkerConfiguration:
        - checker: NPM_CHECKER
          var:
              ALLOWED_SEVERITY_LEVELS: [low, moderate, high, critical]

    ignoreErrors:
        - '#SprykerSdkTest\\InvalidProject\\MultidimensionalArray\\Application1\\ApplicationDependencyProvider#'
        - messages:
              - '#composer\.json#'
              - '#deploy\.dev\.yml#'
          checker: PHP_VERSION_CHECKER
        - messages:
              - '#SprykerSdkTest\\InvalidProject\\MultidimensionalArray\\Application2\\ApplicationDependencyProvider#'
          checker: MULTIDIMENSIONAL_ARRAY_CHECKER