simonschaufi / rule-doc-generator

v13.0.0 2026-11-06 20:58 UTC

Requires

• php: ^7.4 || ^8.0
• illuminate/container: ^8.83
• nette/robot-loader: ^3.0 || ^4.0
• nette/utils: ^3.2.10 || ^4.0
• symfony/console: ^5.4 || ^6.4 || ^7.0
• symfony/filesystem: ^5.4 || ^6.4 || ^7.0
• symfony/yaml: ^5.4 || ^6.4 || ^7.0
• webmozart/assert: ^1.11 || ^2.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.56
• phpstan/phpstan: ^2.1.34
• phpunit/phpunit: ^9.6.17 || ^10.0
• rector/rector: ^2.8.3
• symplify/easy-coding-standard: ^12.3

MIT

Published on Packagist.org on 2026-11-06 21:04 UTC

README

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

Install

composer require simonschaufi/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/my-rules.md