Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK-2568: Evaluator configuration file docs #2179

Merged
merged 9 commits into from
Sep 20, 2023
2 changes: 2 additions & 0 deletions _data/sidebars/scos_dev_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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.