a9f/fractor-doc-generator

Generate docs for Fractor

v0.1.2 2024-05-23 11:57 UTC

Requires

• php: ^8.2
• nette/utils: ^4.0
• sebastian/diff: ^5.0
• symfony/config: ^6.4
• symfony/console: ^6.4
• symfony/dependency-injection: ^6.4
• symplify/rule-doc-generator: 12.1.3

Requires (Dev)

• ergebnis/composer-normalize: ^2.42
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.5
• rector/rector: ^1.0
• symplify/easy-coding-standard: ^12.1

MIT

• Andreas Wolf

README

Generate Documentation for you Fractor rules

Installation

composer require a9f/fractor-doc-generator --dev

Usage

To generate documentation from rules, use generate command with paths that contain the rules:

vendor/bin/fractor-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/fractor-doc-generator generate src/rules --output-file docs/my_rules.md

Happy coding!