diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md index 12613a17ce6..8568e883908 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/additional-logic-in-dependency-provider.md @@ -45,7 +45,7 @@ class FormDependencyProvider extends SprykerFormDependencyProvider 2. `isDevelopment` function call The usage of `isDevelopment` checks is allowed in order to register the plugins that are needed in development mode only (e.g. profiling, debug, etc.). - + ```php namespace Pyz\Zed\Console; @@ -63,7 +63,7 @@ class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider protected function getConsoleCommands(Container $container): array { $commands = []; - + if ($this->getConfig()->isDevelopmentConsoleCommandsEnabled()) { $commands[] = new CodeTestConsole(); } @@ -113,9 +113,7 @@ class FormDependencyProvider extends SprykerFormDependencyProvider } ``` -### Resolving the error - -To resolve the issue: +## Resole the error 1. Try to avoid the usage of conditions in the dependency providers. 2. Use only the supported expressions in the `if` construct. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.md index de5b5236ce4..72a29735b48 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/container-set-function.md @@ -4,13 +4,11 @@ description: Reference information for evaluator tools. template: howto-guide-template --- -The *Container set function* check checks the way plugins are registered in the dependency provider on the project level. +The *Container set function* check checks how plugins are registered in the dependency provider on the project level. ## Problem description -Inside of the dependency provider, you can add the plugin to `\Spryker\Client\Kernel\Container`, by using the `set` method. -To keep the plugins simple, please do not return an array of plugins inside the callback function. -When you need to register a list of plugins, please create a dedicated method for this purpose, return an array of plugins, and call this method inside the callable function. +In the dependency provider, you can add plugins to `\Spryker\Client\Kernel\Container` by using the `set` method. To keep the plugins simple, do not return arrays of plugins inside the callback function. When you need to register a list of plugins, create a dedicated method, return an array of plugins, and call this method inside the callable function. ## Example of an evaluator error message @@ -25,7 +23,7 @@ Target: {PATH_TO_PROJECT}/Pyz/Zed/Checkout/CheckoutDependencyProvider.php:{LINE ## Example of code that causes an evaluator error -The method `addProductSalePageWidgetPlugins` in `ExampleDependencyProvider` contains the callable function that returns an array of plugins, it is not supported for now. +The method `addProductSalePageWidgetPlugins` in `ExampleDependencyProvider` contains a callable function that returns an array of plugins. ```php namespace Pyz\Zed\ContainerSetFunctionChecker; @@ -53,11 +51,9 @@ class ExampleDependencyProvider } ``` -### Resolving the error +## Resolve the error -To resolve the issue: - -1. Create dedicated method for registering plugins. +1. Create a dedicated method for registering plugins. 2. Call the method in the callback function. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md index df5fe6f2273..71760c34996 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/dead-code-checker.md @@ -39,8 +39,6 @@ class SinglePlugin extends SprykerSinglePlugin } ``` -### Resolving the error +## Resolve the error -To resolve the error: - -1. Remove the unused dead code in project. +Remove the unused dead code in project. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md index e4fdf3b328d..f943aee1b0f 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/minimum-allowed-shop-version.md @@ -41,8 +41,6 @@ The following is an example of the `composer.json` file when the used Spryker fe } ``` -### Resolving the error +## Resolving the error -To resolve this issue: - -1. Update the outdated dependencies to make it correspond to the minimum required version. +Update the outdated dependencies to make it correspond to the minimum required version. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md index 1e608a40954..469eeb51623 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/multidimensional-array.md @@ -52,8 +52,6 @@ class ModuleDependencyProvider extends SprykerModuleDependencyProvider } ``` -### Resolving the error +## Resolving the error -To resolve the error: - -1. Try to have simple configuration arrays. They shouldn't have more than two nesting levels inside. +Try to have simple configuration arrays. They shouldn't have more than two nesting levels inside. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.md index 105b206bfc2..a148777448b 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.md @@ -21,7 +21,7 @@ By using the npm vulnerabilities checker with the Evaluator, developers can safe NPM CHECKER =========== -Message: [critical] Prototype pollution in webpack loader-utils +Message: [critical] Prototype pollution in webpack loader-utils https://github.com/advisories/GHSA-76p3-8jx3-jpfq Target: loader-utils @@ -36,6 +36,6 @@ Message: [high] Cross-realm object access in Webpack 5 Read more: https://docs.spryker.com/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/npm-checker.html ``` -### Resolving the issue +## Resolve the error To resolve the issue, update the npm dependencies with known vulnerabilities to the versions where the vulnerability issues are fixed. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/open-source-vulnerabilities.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/open-source-vulnerabilities.md index 787077781f6..fd853e09acf 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/open-source-vulnerabilities.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/open-source-vulnerabilities.md @@ -38,7 +38,7 @@ Your `composer.lock` file contains package versions that have security issues: ... ```` -### Resolving the error +## Resolve the error To resolve the error: 1. Upgrade the package to a version where the vulnerability issue is fixed. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md index 87f87b30d1d..029c9969c12 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/php-version.md @@ -142,7 +142,7 @@ image: Inconsistent PHP versions produce the error message output. -### Resolving the error +## Resolve the error To resolve the issue: 1. Use a supported [Spryker SDK](https://docs.spryker.com/docs/sdk/dev/spryker-sdk.html) PHP version. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md index bddff57f4ff..f2a44790a0f 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/plugin-registration-with-restrintions.md @@ -85,7 +85,7 @@ class CategoryDependencyProvider extends SprykerDependencyProvider } ``` -### Resolving the error +## Resolve the error To solve this issue: diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md index 46edf7fab1c..2fe07a88e9a 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/single-plugin-argument.md @@ -56,7 +56,7 @@ class ConsoleDependencyProvider } ``` -### Resolving the error +## Resolve the error To resolve the error: 1. Refactor the plugin - remove the usage of the complicated constructor arguments. diff --git a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.md b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.md index 10f91ce35a1..402240a508a 100644 --- a/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.md +++ b/docs/scos/dev/guidelines/keeping-a-project-upgradable/upgradability-guidelines/spryker-security-checker.md @@ -40,5 +40,5 @@ Your `composer.lock` file contains package versions that have security issues: ... ```` -### Resolving the error +## Resolve the error To resolve the error, upgrade the package to a version where the vulnerability issue is fixed.