forme/codegen

Forme WordPress 框架的代码生成 CLI 工具

v2.3.3 2024-09-25 19:01 UTC

README

Forme CodeGen

Forme WordPress 框架的代码生成 CLI 工具.

全局安装。

composer global require forme/codegen

点击此处查看文档

开发

开发时,请先运行 phive install --force-accept-unsigned,然后运行 composer install

工具位于 ./tools 而不是 ./vendor/bin

您还需要 git cliff 以生成变更日志,以及 pcov 以生成覆盖率统计,以衡量 infection。

有用的工具已设置为 composer 脚本。

composer test # run pest
composer stan # run phpstan on src
composer rector:check # rector dry run on src
composer rector:fix # rector on src
composer cs:check # php cs fixer dry run on src
composer cs:fix # php cs fixer on src
composer phar:build # build phar with box (experimental, some features don't work yet)
composer changelog # run git cliff
composer hooks # install git hooks (will run on composer install automatically)
composer bump:version # bump to the next patch version - can also take argument "minor" or "major"
composer infection # run infection on src
composer infection:log # run infection on src and log to infection.html

将所有帮助信息输出为 markdown 格式以供文档使用

# requires findutils on OSX - you can drop the "g" xargs prefix on Linux
forme list --raw | cut -d' ' -f1 | gxargs -n1 -d'\n' forme --format=md help | sed $'s/\x1b\\[91m\([A-Za-z\\._-]*\)\x1b\\[0m/`\\1`/g' | sed $'s/    \x1b\\[0\;33m\(.*\)\x1b\\[0m/```bash\\n\\1\\n```/g' | sed $'s,\x1b\\[[0-9;]*[a-zA-Z],,g' > codegen.md

手动步骤

  1. 检查部分/命令标题,因为这似乎不会输出正确的换行符
  2. 查找并替换主文件夹
  3. 复制到文档中