symplify/rule-doc-generator
Generate consistent, readable documentation for custom PHP rules. Symplify Rule Doc Generator creates rule descriptions and examples automatically, helping you document PHPStan, Rector, or coding-standard rules quickly and keep docs in sync with code.
Generate Documentation for you Sniffer, Fixer, Rector, PHPStan... any rule in nice styled Markdown syntax with PHP Code examples everyone will understand.
composer require symplify/rule-doc-generator --dev
To generate documentation from rules, use generate command with paths that contain the rules:
vendor/bin/rule-doc-generator generate src/Rules
The file will be generated to /docs/rules_overview.md by default. To change that, use --output-file:
vendor/bin/rule-doc-generator generate src/Rules --output-file docs/symplify_rules.md
Happy coding!
How can I help you explore Laravel packages today?