README

Craft Generator

从 CLI 创建新的 Craft CMS 插件、模块和系统组件。

安装

在 Craft 项目中运行以下命令进行安装

composer require craftcms/generator --dev

注意 如果出现以下提示，请确保回答 y

yiisoft/yii2-composer contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org.cn/allow-plugins
Do you trust "yiisoft/yii2-composer" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json)

用法

运行以下命令以输出用法说明

php craft make

插件和模块生成

您可以使用以下命令创建新的插件和模块

php craft make plugin
php craft make module

系统组件生成

您可以使用以下命令创建新的系统组件

php craft make asset-bundle
php craft make behavior
php craft make command
php craft make controller
php craft make element-action
php craft make element-condition-rule
php craft make element-exporter
php craft make element-type
php craft make field-type
php craft make filesystem-type
php craft make generator
php craft make gql-directive
php craft make model
php craft make module
php craft make plugin
php craft make queue-job
php craft make record
php craft make service
php craft make twig-extension
php craft make utility
php craft make validator
php craft make widget-type

所有组件生成命令都需要传递以下选项之一，以确定组件将驻留的位置

• --app
• --module=<module-id>
• --plugin=<plugin-handle>

例如，如果您正在为名为 foo-bar 的插件创建新的字段类型，则运行

php craft make field-type --plugin=foo-bar

创建自定义生成器

如果您有一个具有自己的组件类型且可从自定义生成器中受益的插件，您可以使用以下命令快速创建一个

php craft make generator --plugin=<plugin-handle>

您将看到以下提示

• 生成器名称：您的生成器类名（不包含命名空间）
• 生成器命名空间：您的生成器类应驻留的命名空间
• 生成 [类型] 的基本类：生成类应扩展的现有基本类
• 生成 [类型] 的默认命名空间：生成器应建议的默认命名空间，相对于插件/模块的根命名空间

您的生成器将根据提供的类名和命名空间创建，该类名扩展自 craft\generator\BaseGenerator。

路线图

以下生成器类型正在考虑在未来版本中实现

• 事件
• 异常
• GraphQL 参数
• GraphQL 指令
• GraphQL 接口
• GraphQL 变异
• GraphQL 查询
• GraphQL 解析器
• GraphQL 类型
• 迁移
• 测试