mcpField
W
woocommerce-email-editor

woocommerce-email-editor

github.com/woocommerce开发10.6k192 次安装今天更新
代码仓库

关于 woocommerce-email-editor

为 WooCommerce 区块邮件编辑器开发提供本地环境、构建和测试指导，适用于修改邮件模板及 PHP、JavaScript 包的开发者。还介绍使用 Mailpit 在本地测试邮件发送。

主要功能

  1. 01wp-env 本地环境设置
  2. 02邮件编辑器 JS 构建与监视
  3. 03Mailpit 邮件发送测试
  4. 04PHP 集成测试与静态检查

适用场景

  1. 01启动区块邮件编辑器开发环境
  2. 02本地验证事务邮件发送
  3. 03运行 PHP 包集成测试

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/woocommerce/woocommerce --skill woocommerce-email-editor

安装后在 Claude Code 中输入/woocommerce-email-editor确认已加载。

详细介绍

WooCommerce 邮件编辑器开发

本技能提供开发 WooCommerce 区块邮件编辑器的指导。

何时使用此技能

在以下情况下调用此技能：

  • 设置邮件编辑器的本地开发环境
  • 处理邮件模板或事务性邮件
  • 修改邮件编辑器 PHP 或 JS 包
  • 测试邮件发送功能

开发环境设置

1. 启动 WooCommerce wp-env
pnpm --filter=@woocommerce/plugin-woocommerce -- wp-env start

站点默认运行在 http://localhost:8888。如果端口 8888 不可用，wp-env 会分配其他端口。查看启动输出或运行 wp-env info，了解实际 URL。

2. 启动监视器

监视并构建管理界面的 JS 文件（包括邮件编辑器 JS 包），并同步邮件编辑器 PHP 包的更改：

pnpm --filter=@woocommerce/plugin-woocommerce watch:build:admin
3. 启用区块邮件编辑器功能

访问 http://localhost:8888/wp-admin/admin.php?page=wc-settings&tab=advanced&section=features 并启用区块邮件编辑器。

4. 编辑事务性邮件

访问 http://localhost:8888/wp-admin/admin.php?page=wc-settings&tab=email

使用 Mailpit 测试邮件

要在本地测试邮件发送，请使用 Mailpit 作为本地 SMTP 服务。

配置 SMTP

添加到 plugins/woocommerce/.wp-env.override.json：

{
    "lifecycleScripts": {
        "afterStart": "./tests/e2e/bin/test-env-setup.sh && wp-env run cli wp plugin install wp-mail-smtp --activate"
    },
    "config": {
        "WPMS_ON": true,
        "WPMS_MAILER": "smtp",
        "WPMS_SMTP_HOST": "host.docker.internal",
        "WPMS_SMTP_PORT": "1025",
        "WPMS_SMTP_AUTH": false,
        "WPMS_SMTP_SECURE": ""
    }
}
启动 Mailpit
docker run --rm --name=mailpit -p 1025:1025 -p 8025:8025 -d axllent/mailpit

或者，如果容器已存在：

docker start mailpit
查看邮件

打开 http://localhost:8025 查看捕获的邮件。

重启 wp-env

创建或修改 .wp-env.override.json 后，重启环境：

pnpm --filter=@woocommerce/plugin-woocommerce -- wp-env start --update

关键路径

路径描述
packages/php/email-editor/邮件编辑器 PHP 包
packages/js/email-editor/邮件编辑器 JS 包
plugins/woocommerce/.wp-env.override.json本地 wp-env 配置（已加入 gitignore）

构建邮件编辑器包

更改后重新构建 JS 包：

pnpm --filter=@woocommerce/email-editor build

测试 PHP 包

在 packages/php/email-editor/ 目录中运行测试。

设置
cd packages/php/email-editor
wp-env start
composer dump-autoload
运行集成测试
wp-env run tests-cli --env-cwd=wp-content/plugins/email-editor ./vendor/bin/phpunit --configuration phpunit-integration.xml.dist
运行指定测试
wp-env run tests-cli --env-cwd=wp-content/plugins/email-editor ./vendor/bin/phpunit --configuration phpunit-integration.xml.dist --filter Table_Test

对 PHP 包运行代码检查

在 packages/php/email-editor/ 目录中运行。

PHPStan
cd tasks/phpstan && ./run-phpstan.sh

要兼容 PHP 7：

cd tasks/phpstan && ./run-phpstan.sh php7
PHPCS
composer run phpcs

评论

支持 Markdown