symplify/rule-doc-generator

代码规范或静态分析规则文档生成器

12.2.5 2024-08-08 12:13 UTC

This package is auto-updated.

Last update: 2024-09-08 12:21:59 UTC


README

为您的Sniffer、Fixer、Rector、PHPStan... 生成任何规则的文档,使用易于理解的Markdown语法和PHP代码示例。

Downloads total

安装

composer require symplify/rule-doc-generator --dev

用法

要从规则生成文档,请使用带有包含规则的路径的 generate 命令

vendor/bin/rule-doc-generator generate src/Rules

默认情况下,文件将生成到 /docs/rules_overview.md。要更改此,请使用 --output-file

vendor/bin/rule-doc-generator generate src/Rules --output-file docs/symplify_rules.md

快乐的编码!