woocommerce/tools/code-analyzer/zh-cn/README.md
2026-04-15 10:18:01 +08:00

37 lines
No EOL
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 代码分析器
## 描述
`code-analyzer` 是一个 CLI 工具,旨在分析 WooCommerce 单体仓库中插件的变更信息。
## 命令
当前有 3 个命令:
1. `lint`。分析器用作 PR 的 linter以检查是否引入了钩子/模板/数据库变更。它可以直接在 CI 上输出,或通过在 GH 操作中设置输出变量来输出。
以下是一个 `analyzer` 命令的示例,从该目录运行:
`pnpm analyzer lint "release/6.8" "6.8.0" -b release/6.7`
在此命令中,我们比较 `release/6.7``release/6.8` 分支以查找差异,并且我们正在查找自 `6.8.0` 以来引入的变更(使用 `@since` 标签)。
要了解该命令的其他参数,可以运行 `pnpm analyzer -- --help`
2. `major-minor`。这个简单的 CLI 工具根据 Woo 发布约定,为您提供插件主文件的最新 `.0` 主要/次要发布版本。
以下是一个 `major-minor` 命令的示例,从该目录运行:
`pnpm analyzer major-minor "release/6.8" "plugins/woocommerce/woocommerce.php"`
在此命令中,我们检出 `release/6.8` 分支,并检查位于传递路径的 woocommerce.php 主文件的版本。请注意,在撰写本文时,此特定分支中的主文件报告为 `6.8.1`,因此此命令的输出为 `6.8.0`
此命令与分析器结合使用时特别有用,允许您在将该版本作为 `analyzer` 的版本参数传递之前,确定分支或引用的最后一个主要/次要 .0 版本。
3. `scan`。Scan 类似于 `lint`,但允许您扫描特定的变更类型。例如,如果您愿意,可以仅扫描钩子变更。
以下是一个运行 `scan` 命令以查找钩子变更的示例:
`pnpm analyzer scan hooks "release/6.8" "release/6.7" --since "6.8.0"`
在此命令中,我们比较 `release/6.7``release/6.8` 分支以查找钩子变更,并且我们正在查找自 `6.8.0` 以来引入的变更(使用 `@since` 标签)。