symplify/rule-doc-generator

Documentation generator for coding standard or static analysis rules

This package is auto-updated.

Last update: 2021-09-24 12:11:35 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!


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.