README

这是一个代码生成工具，用于自动化 Square One 项目的一些重复性任务。该包提供的 WP CLI 命令将创建占位符文件，帮助您开始自定义工作。

组件生成器

wp s1 generate component <component>

生成主题组件所需的各种文件。

示例用法

wp s1 generate component link

这将为您在主题中创建六个文件

• components/link/link.php
• components/link/Link_Controller.php
• components/link/index.pcss
• components/link/css/link.pcss
• components/link/index.js
• components/link/js/link.js

模板（link.php）和控制器类（Link_Controller.php）将包含常见的属性。

使用 --no-template 跳过模板。

使用 --no-controller 跳过控制器类。

使用 --no-css 跳过 CSS 文件。

使用 --no-js 跳过 JS 文件。

--dry-run 标志将显示命令会创建的文件，而不会写入文件系统。

您可以使用此命令在嵌套目录中生成组件。例如，wp s1 generate component content/event ... 将在 components/content/event 中创建组件。所有 PHP 类的命名空间都将调整以反映其在层次结构中的位置。

自定义文章类型生成器

wp s1 generate cpt <cpt> [--single=<single>] [--plural=<plural>]

生成自定义文章类型所需的文件。

示例用法

wp s1 generate cpt document --single="Document" --plural="Documents"

这将为您在核心插件中创建三个文件

• src/Post_Types/Document/Document.php
• src/Post_Types/Document/Config.php
• src/Post_Types/Document/Subscriber.php

并在 Tribe\Project\Core 中添加对订阅者的引用。

自定义分类生成器

wp s1 generate tax <taxonomy> [--post-types=<post-types>] [--single=<single>] [--plural=<plural>]

生成自定义分类所需的文件。

示例用法

wp s1 generate tax classification --post-types="page,post" --single="Classification" --plural="Classifications"

这将为您在核心插件中创建三个文件

• src/Taxonomies/Classification/Classification.php
• src/Taxonomies/Classification/Config.php
• src/Taxonomies/Classification/Subscriber.php

并在 Tribe\Project\Core 中添加对订阅者的引用。

块生成器

wp s1 generate block <name>

生成注册新块所需的文件。

示例用法

wp s1 generate block image-gallery

这将为您在核心插件中创建两个文件

• src/Blocks/Types/Image_Gallery/Image_Gallery.php
• src/Blocks/Types/Image_Gallery/Image_Gallery_Model.php

并在主题中创建块模板

• blocks/imagegallery.php

然后委托给组件生成器（见上文）以生成 image_gallery 组件。

--dry-run 标志将显示命令会创建的文件，而不会写入文件系统。

使用文章循环字段中间件的示例

wp s1 generate block image-gallery --with-post-loop-field-middleware

设置页面生成器

TODO：编写设置页面生成器的文档

CLI 命令生成器

TODO：编写 CLI 命令生成器的文档

图像尺寸生成器

wp s1 generate image-size <name> [--width=<width>] [--height=<height>] [--ratio=<ratio>] [--crop=<crop>]

将图像尺寸添加到核心插件的 Image_Sizes 类中。

示例用法

wp s1 generate image-size test-size --width=1000 --ratio=0.75 --crop=left,top

这将向 Image_Sizes 类添加常量 TEST_SIZE 并将其添加到 $sizes 数组中

self::TEST_SIZE => [
	'width'  => 1000,
	'height' => 750,
	'crop'   => [ 'left', 'top' ],
]