symplify/rule-doc-generator
This package is abandoned and no longer maintained.
No replacement package was suggested.
Documentation generator for coding standard or static analysis rules
Maintainers
12.2.5
2024-08-08 12:13 UTC
Requires
- php: >=7.2
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
MIT 0bed481b115cf801edff518ac0d27be2dd182f62
This package is auto-updated.
Last update: 2025-01-13 13:01:03 UTC
README
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!