Rule Doc Generator

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

Install

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

Usage

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!