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

Installs: 2 647 960

Dependents: 31

Suggesters: 0

Security: 0

Stars: 31

Watchers: 5

Forks: 3

Open Issues: 0

pkg:composer/symplify/rule-doc-generator

12.2.5 2024-08-08 12:13 UTC

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.

Downloads total

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!