diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index bc6b78ab248..de9bd5ac6a6 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -4805,6 +4805,8 @@ entries: url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.html - title: Single plugin argument url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.html + - title: Ignore evaluation errors + url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/ignore-evaluation-errors.html - title: Performance guidelines url: /docs/scos/dev/guidelines/performance-guidelines/performance-guidelines.html nested: diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/ignore-evaluation-errors.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/ignore-evaluation-errors.md new file mode 100644 index 00000000000..8db440ffc20 --- /dev/null +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/ignore-evaluation-errors.md @@ -0,0 +1,36 @@ +--- +title: Ignore evaluation errors +description: Reference information for evaluator configuration file. +template: howto-guide-template +--- + +In some cases, the evaluator's rules may cause false positive errors. Then you can configure the evaluator to ignore some errors. + +1. To configure the evaluator to ignore errors, add `tooling.yml` to the project's root directory. + +```yaml + +evaluator: + # evaluator options + ... + +``` + +2. In the `ignoreErrors` section, add the errors to ignore using regular expressions. + You can specify errors to ignore globally or per specific checker. + +**tooling.yml** +```yaml + +evaluator: + ignoreErrors: + # global error ignore regexp + - '#SprykerSdkTest\\InvalidProject\\MultidimensionalArray\\Application1\\ApplicationDependencyProvider#' + # error ignore regexp for a defined checker + - messages: + - '#deploy.*\.yml#' + - '#php\.7\.4#' + checker: PHP_VERSION_CHECKER +``` + +The error message matching the regular expressions should now be ignored.