Documentation generator for coding standard or static analysis rules

12.1.10 2024-03-18 21:45 UTC

This package is auto-updated.

Last update: 2024-04-08 07:15:37 UTC


Generate Documentation for you Sniffer, Fixer, Rector, PHPStan... any rule in nice styled Markdown syntax with PHP Code examples everyone will understand.

Downloads total


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/ by default. To change that, use --output-file:

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

Happy coding!