mcpField
W
woocommerce-local-env

woocommerce-local-env

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

关于 woocommerce-local-env

用于通过 wp-env 在本地运行 WooCommerce Core 的技能，涵盖环境设置、生命周期命令、构建监听、验证和故障排查，并区分由 Agent 执行的任务与用户负责的长期监听进程。

主要功能

  1. 01启动、停止和重启 wp-env
  2. 02按需安装依赖
  3. 03运行完整或定向构建监听
  4. 04检查前置条件及站点响应
  5. 05排查 Docker 和资源更新问题

适用场景

  1. 01搭建 WooCommerce Core 本地开发环境
  2. 02针对特定区域修改时重新构建资源
  3. 03检查本地站点是否正常响应

安装

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

$npx skills add https://github.com/woocommerce/woocommerce --skill woocommerce-local-env

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

详细介绍

WooCommerce 本地环境

概述

使用此技能可在本地运行 WooCommerce Core，无需重新阅读 plugins/woocommerce/README.md 和 .wp-env.json。

如果存在简短的根目录脚本，请优先使用。如果没有可用的别名，则改用经过筛选的包命令。

进程归属

决定是运行命令还是告知用户运行命令时，请遵循以下归属规则：

  • 根据任务需要，由 Agent 运行设置检查、依赖项安装、一次性构建以及 wp-env 启动／停止命令。这些命令应在完成后返回控制权。
  • 将 watch:* 命令视为由用户负责的长时间运行进程。告知用户在单独的终端中运行相关监视器，除非确实需要启动一个短暂的临时监视器来进行主动验证。
  • 尽可能复用已运行的环境。
  • 完成前，停止或清理由 Agent 启动的任何长时间运行会话。

快速命令

从代码仓库根目录运行：

# Start the wp-env development environment at http://localhost:8888/.
pnpm wc:env

# Stop or restart wp-env.
pnpm wc:env:stop
pnpm wc:env:restart

# Watch all WooCommerce Core build outputs.
pnpm wc:watch

# Watch targeted build outputs.
pnpm wc:watch:admin
pnpm wc:watch:blocks
pnpm wc:watch:classic-assets

# Build all or targeted outputs once.
pnpm wc:build
pnpm wc:build:admin
pnpm wc:build:blocks
pnpm wc:build:classic-assets

pnpm wc:env:restart 会销毁并重新创建 wp-env 容器，因此只有在确实需要干净重启时才使用。

WooCommerce 包中的备用命令：

pnpm --filter='@woocommerce/plugin-woocommerce' env:dev
pnpm --filter='@woocommerce/plugin-woocommerce' env:stop
pnpm --filter='@woocommerce/plugin-woocommerce' env:restart
pnpm --filter='@woocommerce/plugin-woocommerce' build
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:admin
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:blocks
pnpm --filter='@woocommerce/plugin-woocommerce' watch:build:classic-assets

在 plugins/woocommerce/ 中直接运行包脚本，例如 pnpm env:dev 或 pnpm watch:build。

设置工作流

  1. 设置失败或用户要求首次设置时，检查前置条件：

    node --version
pnpm --version
php --version
composer --version
docker --version
docker info

  2. 仅当依赖项缺失或过时时，才从代码仓库根目录安装依赖项：

    pnpm install

  3. 启动环境：

    pnpm wc:env

  4. 如果前端或资源文件的更改需要实时重新构建，告知用户在单独的终端中启动监视器：

    pnpm wc:watch

对于范围明确的工作，建议使用针对性的监视器，以减少干扰并缩短启动时间：

  • Admin 客户端：pnpm wc:watch:admin
  • Blocks 客户端：pnpm wc:watch:blocks
  • Classic 资源：pnpm wc:watch:classic-assets

环境详情

  • 开发 URL：http://localhost:8888/
  • 测试环境端口：8086
  • wp-env 配置：plugins/woocommerce/.wp-env.json
  • wp-env PHP 版本：8.1
  • WooCommerce 包：@woocommerce/plugin-woocommerce
  • 源 README：plugins/woocommerce/README.md

验证

启动 wp-env 后，验证站点是否有响应：

curl -I http://localhost:8888/

如果用户要求检查或测试本地站点，请使用 Browser 插件打开 http://localhost:8888/ 进行基于浏览器的验证。

故障排除

  • 如果 docker info 失败，请让用户启动 Docker Desktop，然后重试。
  • 如果依赖项发生变更后 pnpm wc:env 失败，请运行 pnpm install，然后重试。
  • 如果 wp-env 容器似乎已过时，请先确认可以接受破坏性环境重置，再运行 pnpm wc:env:restart。
  • 如果资源文件未更新，请确认相应的监视器正在运行，并针对更改的区域使用专门的监视器。
  • 如果用户只需要运行 PHP 单元测试，请优先使用 woocommerce-dev-cycle 中的测试命令；除非确有需要，否则不要启动完整的浏览器工作流。

评论

支持 Markdown