README

这是一个现代、由 JavaScript 驱动的 WooCommerce Admin 体验的功能插件。

先决条件

为了更好的调试，建议您将 define( 'SCRIPT_DEBUG', true ); 添加到 wp-config。这将加载所有库的非压缩版本，特别是 React 的开发版本。

在克隆存储库后，安装依赖项

现在您可以使用以下命令之一构建文件

pnpm run build : 构建生产版本
pnpm run dev : 构建开发版本
pnpm start : 构建开发版本，监视文件更改
pnpm run build:release : 构建WordPress插件ZIP文件（在存储库根目录中创建 woocommerce-admin.zip）
DRY_RUN=1 pnpm run build:release : 构建 WordPress 插件 ZIP 不推送到 Github 并创建发行版。

有关更多辅助脚本请参见此处

有关一些调试工具/帮助请参见此处

有关使用 Docker 进行本地开发设置请参见此处

使用 npm run ts:check 命令将检查您的 TypeScript 文件中的错误，并已添加到 .vscode/tasks.json。在 vscode 中运行此任务将在编辑器文件导航器中突出显示错误。

如果允许 npm run ts:check:watch 命令自动运行（如配置），它将在后台运行并捕获您保存文件时出现的任何错误。注意：即使您不运行此任务，IDE 也使用其语言服务器来捕获已打开文件中的类型错误。只有在需要捕获整个存储库中的错误（即使它们尚未在 IDE 中打开）时才需要此任务。

测试位于 ./tests/e2e。运行之前需要现有构建，请参阅上面的部分获取步骤。E2E 测试使用 @woocommerce/e2e-environment 包，该包托管一个用于测试的 Docker 容器，默认情况下，容器可以通过 http://localhost:8084 访问。

可以通过 pnpm exec 运行 @woocommerce/e2e-environment 的所有命令。

# Set up the e2e environment
pnpm i
pnpm exec wc-e2e docker:up

使用以下命令运行测试

pnpm exec wc-e2e test:e2e-dev

或在无头模式下运行

pnpm exec wc-e2e test:e2e

通过添加文件名路径来运行单个测试

pnpm exec wc-e2e test:e2e-dev tests/e2e/specs/activate-and-setup/complete-onboarding-wizard.test.ts

在存储库中提供了两种形式的文档。一组由 docsify 支持的静态文档，以及包含 @woocommerce/components 组件文档的 Storybook。

要本地查看 docsify 文档，可以这样做

pnpm install
cd docs
pnpm exec docsify serve

当部署时，docsify 文档还托管 Storybook 文档的嵌入版本。要在 docsify 中生成并本地测试它，您需要运行

pnpm install
pnpm run docs
cd docs
pnpm exec docsify serve

然后从文档的左侧菜单导航到 组件。

如果您想单独查看托管的故事书文档，则可以运行

pnpm install
pnpm run storybook

如果您想以从右到左的样式查看故事书文档，则可以运行此命令代替

pnpm install
pnpm run storybook-rtl

如果您在设置过程中遇到任何问题，我们可能也遇到过类似的情况。请查看我们的wiki，了解常见问题的列表。

如果您已启用 WooCommerce 使用情况跟踪（选项 woocommerce_allow_tracking），则除了在https://woocommerce.com/usage-tracking/ 中描述的跟踪外，此插件还会将站点管理员执行的操作信息发送到 Automattic - 更多信息请参阅https://automattic.com/privacy/#information-we-collect-automatically。

有多种方式可以做出贡献 - 报告错误、添加翻译、提出功能建议和修复错误。有关完整详细信息，请参阅CONTRIBUTING.md