README

这是一个方便的包装器，围绕wordpress-hook-parser，修复一些依赖项，并将其作为CLI工具提供，我们可以在项目中使用。

它解析传递给它的文件夹，并生成包含所有钩子、过滤器和相应文档的Markdown文件。

要查看生成的Markdown文件的示例，请点击此处。

安装

不幸的是，由于Composer 2，Composer 1包的缓存计划没有像以前那样频繁更新。所以如果您无法通过composer global require next-press/wordpress-hook-generator安装它，请先尝试以下安装方法。

# Clone the repo onto your home directory
cd && git clone https://github.com/next-press/wordpress-hook-generator
cd wordpress-hook-generator

# Install dependencies
composer install
npm install

# Link the binary to /usr/local/bin, so it becomes available
# system-wise via the command `wordpress-hook-generator`.
composer link

应该如何做

作为一个CLI工具，它应该使用Composer全局安装。

要安装它，只需运行

composer global require next-press/wordpress-hook-generator

用法

全局安装后，CLI命令wordpress-hook-generator将可在系统范围内使用。

然后您只需运行它，将目标文件夹作为第一个参数传递。

wordpress-hook-generator path/to/folder

选项

除了要扫描的路径之外，还可以将其他选项传递给命令。

输出文件 -o

默认情况下，输出写入到命令运行目录中名为actions.md的文件中。

您可以通过使用带有-o选项的文件路径来覆盖输出文件名。

wordpress-hook-generator path/to/folder -o custom-output-file-name.md

忽略文件夹 -i

默认情况下，扫描目标目录时将忽略供应商文件夹。如果您想传递其他要忽略的文件夹名称，可以使用-i选项。

-i选项接受以逗号分隔的目录名称列表。

wordpress-hook-generator path/to/folder -i dependencies,release

启用调试 -d

默认情况下，在生成文档时抛出的PHP警告被抑制，不会在终端窗口中显示。添加-d标志将显示警告消息。

更新工具

您可以通过运行以下命令更新工具

wordpress-hook-generator --update

开发

要开发、测试或调试此工具，请克隆此存储库，然后务必首先安装PHP和node.js依赖项。

克隆存储库

git clone https://github.com/next-press/wordpress-hook-generator
cd wordpress-hook-generator

然后对于PHP，安装composer依赖项。

composer install

同样，使用npm为node.js做相同的事情。

npm install

重要：版本控制

要增加版本号，请在根目录中运行以下命令。此命令是npm version命令的简写，默认情况下它会增加补丁版本号（例如，从0.0.1增加到0.0.2）。

composer bump

如果您需要增加主要或次要版本号，请使用以下完整命令

对于次要版本

npm --no-git-tag-version version minor

对于主要版本

npm --no-git-tag-version version major

无需手动更新代码中的@version标签，因为Husky会运行一个pre-commit来同步版本号，确保它们始终保持自动更新。

变更日志

版本 0.0.7 - 发布于 2021-01-11

• 修复：现在尊重@ignore标签；
• 新增：通过--update标志自动更新。

版本 0.0.6 - 发布于 2021-01-10

• 修复：在类方法内部处理过滤器和动作；
• 修复：对模板的最终调整；

版本 0.0.5 - 发布于 2021-01-09

• 新增：包含额外数据的模板；

版本 0.0.4 - 发布于 2021-01-08

• 文档：添加一个作为 composer global require 的备选安装方法；

版本 0.0.3 - 发布于 2021-01-08

• 新增：链接脚本 - 当 composer v1 的包不在 Packagist 上可用时使用；
• 新增：当存在 --debug 标志时，更好的错误和警告信息处理；

版本 0.0.2 - 发布于 2021-01-08

• 改进：将 composer.json 添加到同步版本号文件列表；

版本 0.0.1 - 初次发布 - 发布于 2021-01-08

• 初次发布；