README

安装

composer require --dev spryker-sdk/spryk

这是一个仅用于开发的 "require-dev" 模块。请确保您将其作为此类包含。

什么是 Spryks？

Spryks 是 Spryker 的某种代码生成器。编写代码通常是一项非常重复的任务，你通常需要编写大量代码才能遵循 Spryker 的干净和复杂的架构。为了从编写设置代码中解脱出来，并更快地编写业务代码，Spryks 就应运而生。

Spryks 是通过 yml 文件编写的。yml 文件的文件名也代表了 Spryk 的名称。在大多数情况下，Spryk yml 包含了满足 Spryk 构建运行所需的参数。几乎所有 Spryks 都需要模块名称才能正常运行。一些 Spryks 需要更多的参数。

大多数 Spryks 需要先执行其他 Spryks，然后被调用的 Spryk 才能运行。例如，添加 Zed Business Facade 需要创建一个适当的模块，然后 Facade 本身才能创建。因此，Spryks 有预 Spryks 和后 Spryks，通过调用一个 Spryk，可以为您创建许多东西。

如何使用 Spryks？

• vendor/bin/spryk-run - 在您的项目中运行 Spryks
• vendor/bin/spryk-dump - 列出所有可用的 Spryks
• vendor/bin/spryk-build - 为所有 Spryk 参数构建缓存文件

示例

1. 要获取顶级 spryks 的列表，请运行 vendor/bin/spryk-dump。
2. 要获取所有可用的 spryks 的列表，请运行 vendor/bin/spryk-dump --level=all。
3. 要获取特定 spryk 的所有可用选项的列表，请运行 vendor/bin/spryk-dump {SPRYK NAME}。
4. 要执行一个 Spryk，请运行 vendor/bin/spryk-run {SPRYK NAME}。
5. 要反映 Spryk 参数的变化并为其生成新的缓存，请运行 vendor/bin/spryk-build。

当你运行一个 Spryk 时，控制台会询问你所有需要的参数来构建 Spryk。你也可以通过使用 --{argument name}={argument value} 在控制台上传递所有已知的参数。

扩展 Spryk

添加 Spryks

您可以通过在项目的 config/spryk/spryks/ 目录中创建 Spryk 定义来添加您自己的 Spryks。

此目录中的 Spryk 定义将被工具找到并可以像往常一样执行。

添加 Spryk 模板

您可以通过在项目的 config/spryk/templates/ 目录中创建模板来添加您自己的 Spryk 模板。

此目录中的 Spryk 模板将被工具找到并可以在您的 Spryks 中使用。

配置

Spryks 需要一些与项目相关的配置。这些配置将自动传递给工具。

以下配置将传递给 Spryk 工具

• Spryker\Shared\Kernel\KernelConstants::PROJECT_NAMESPACE
• Spryker\Shared\Kernel\KernelConstants::PROJECT_NAMESPACES
• Spryker\Shared\Kernel\KernelConstants::CORE_NAMESPACES