spryker-sdk/evaluator

The tool for evaluating Spryker shops

0.2.6 2024-11-04 13:08 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• ext-json: *
• composer/semver: ^3.3
• guzzlehttp/guzzle: ^7.5
• nikic/php-parser: ^5.1.0
• spryker-sdk/security-checker: ^0.2.0
• spryker-sdk/utils: ^0.2.1
• symfony/console: ^6.0
• symfony/dotenv: ^6.0
• symfony/filesystem: ^6.0
• symfony/flex: ^1.17|^2
• symfony/framework-bundle: ^6.0
• symfony/monolog-bundle: ^3.8
• symfony/process: ^6.0
• symfony/runtime: ^6.0
• symfony/serializer: ^6.0
• symfony/stopwatch: ^6.0
• symfony/uid: ^6.0
• symfony/yaml: ^6.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.6
• spryker/code-sniffer: ^0.17.18

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *

proprietary

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