symplify/rule-doc-generator

Documentation generator for coding standard or static analysis rules

12.0.3 2023-09-24 09:37 UTC

Requires

• php: >=8.1
• illuminate/container: ^10.18
• nette/robot-loader: ^3.4
• nette/utils: ^3.2
• sebastian/diff: ^5.0
• symfony/console: ^6.2
• symfony/filesystem: ^6.3
• symfony/yaml: ^6.3
• symplify/rule-doc-generator-contracts: ^11.1
• webmozart/assert: ^1.11

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.3
• rector/rector: ^0.17
• symplify/easy-ci: ^11.2
• symplify/easy-coding-standard: ^12.0
• tomasvotruba/class-leak: ^0.1
• tomasvotruba/cognitive-complexity: ^0.1.1
• tomasvotruba/unused-public: ^0.3
• tracy/tracy: ^2.10

MIT

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!

Report Issues

In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker

Contribute

The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.