Skip to content

Commit

Permalink
SDK-5711: Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelmaksimov25 committed Jan 8, 2024
1 parent e622b7c commit 15b206a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Build Status](https://github.com/spryker-sdk/sdk/workflows/CI/badge.svg?branch=master)](https://github.com/spryker-sdk/sdk/actions?query=workflow%3ACI+branch%3Amaster)
[![codecov](https://codecov.io/gh/spryker-sdk/sdk/branch/master/graph/badge.svg?token=Ff8EDd0kgG)](https://codecov.io/gh/spryker-sdk/sdk)
[![Latest Stable Version](https://poser.pugx.org/spryker-sdk/sdk/v/stable.svg)](https://packagist.org/packages/spryker-sdk/sdk)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.4-8892BF.svg)](https://php.net/)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.0-8892BF.svg)](https://php.net/)
[![PHPStan](https://img.shields.io/badge/PHPStan-level%208-brightgreen.svg?style=flat)](https://phpstan.org/)

The Spryker SDK aims to provide a single entry point to accelerate your productivity working with Spryker.
Expand Down
30 changes: 15 additions & 15 deletions docs/value_resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

The Spryker SDK has the following value resolvers:

| Value Resolver name | Description |
|--------------------------|------------------------------------------------------------------------------------------------------|
| APP_PHP_VERSION | Resolves the PHP version (7.4, 8.0). |
| APP_TYPE | Resolves a repository for creating a project. |
| B2BC_TYPE | Resolves a repository for public b2b or b2c. |
| CONFIG_PATH (depricated) | Resolves a relative path by priority: `project` path, then, by default, the `sdk` path if it exists. |
| FLAG | Resolves flag options. This resolver has the boolean type. |
| NAMESPACE | Used for the spryk tool to resolve namespaces for the tool. It is based on settings. |
| PC_SYSTEM | Resolves the operating system like Linux, Mac, Mac (ARM). |
| PRIORITY_PATH | Resolves the relative path for the tool entry point: `project` path, then, by default, the `sdk` path if it exists. |
| REPORT_DIR | Resolves the report file path. |
| SDK_DIR | Resolves the path to the sdk folder. |
| CORE | Resolves the core level. This resolver is based on the resolved values of the `NAMESPACE` resolver. |
| STATIC | This resolver is used as a universal value resolver with additional settings. It returns the formatted value. |
| ORIGIN | This resolver is used as a universal value resolver with additional settings. It returns the original value. |
| Value Resolver name | Description |
|--------------------------|---------------------------------------------------------------------------------------------------------------------|
| APP_PHP_VERSION | Resolves the PHP version (8.0, 8.1). |
| APP_TYPE | Resolves a repository for creating a project. |
| B2BC_TYPE | Resolves a repository for public b2b or b2c. |
| CONFIG_PATH (depricated) | Resolves a relative path by priority: `project` path, then, by default, the `sdk` path if it exists. |
| FLAG | Resolves flag options. This resolver has the boolean type. |
| NAMESPACE | Used for the spryk tool to resolve namespaces for the tool. It is based on settings. |
| PC_SYSTEM | Resolves the operating system like Linux, Mac, Mac (ARM). |
| PRIORITY_PATH | Resolves the relative path for the tool entry point: `project` path, then, by default, the `sdk` path if it exists. |
| REPORT_DIR | Resolves the report file path. |
| SDK_DIR | Resolves the path to the sdk folder. |
| CORE | Resolves the core level. This resolver is based on the resolved values of the `NAMESPACE` resolver. |
| STATIC | This resolver is used as a universal value resolver with additional settings. It returns the formatted value. |
| ORIGIN | This resolver is used as a universal value resolver with additional settings. It returns the original value. |

Example of a placeholder with the `STATIC` value resolver and with the configuration. See [conventions](conventions.md#Placeholder) for details:

Expand Down

0 comments on commit 15b206a

Please sign in to comment.