PHPackages                             symplify/rule-doc-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. symplify/rule-doc-generator

AbandonedLibrary[Utility & Helpers](/categories/utility)

symplify/rule-doc-generator
===========================

Documentation generator for coding standard or static analysis rules

12.2.5(1y ago)312.7M↑23.8%320MITPHPPHP >=7.2

Since Oct 3Pushed 1y ago3 watchersCompare

[ Source](https://github.com/symplify/rule-doc-generator)[ Packagist](https://packagist.org/packages/symplify/rule-doc-generator)[ Fund](https://www.paypal.me/rectorphp)[ GitHub Sponsors](https://github.com/tomasvotruba)[ RSS](/packages/symplify-rule-doc-generator/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (337)Used By (20)

Rule Doc Generator
==================

[](#rule-doc-generator)

Generate Documentation for you Sniffer, Fixer, Rector, PHPStan... any rule in nice styled Markdown syntax with PHP Code examples everyone will understand.

[![Downloads total](https://camo.githubusercontent.com/0fa801aa0441496f34d6a9e81002b63d12a2b02f6a9e49d95e45e0d380067e4d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73796d706c6966792f72756c652d646f632d67656e657261746f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/symplify/rule-doc-generator/stats)

Install
-------

[](#install)

```
composer require symplify/rule-doc-generator --dev
```

Usage
-----

[](#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!

###  Health Score

49

—

FairBetter than 95% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity51

Moderate usage in the ecosystem

Community27

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 88.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Recently: every ~17 days

Total

336

Last Release

649d ago

Major Versions

8.3.48 → 9.0.0-BETA12020-11-14

9.4.70 → 10.0.0-beta12021-11-02

10.3.3 → 11.0.02022-06-13

11.2.0 → 12.0.02023-08-12

PHP version history (5 changes)8.3.27PHP >=7.2

9.0.0-rc1PHP >=7.3

v9.3.27PHP >=8.0

11.1.11PHP >=8.1

12.1.2PHP >=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/924196?v=4)[Tomas Votruba](/maintainers/TomasVotruba)[@TomasVotruba](https://github.com/TomasVotruba)

---

Top Contributors

[![actions-user](https://avatars.githubusercontent.com/u/65916846?v=4)](https://github.com/actions-user "actions-user (507 commits)")[![TomasVotruba](https://avatars.githubusercontent.com/u/924196?v=4)](https://github.com/TomasVotruba "TomasVotruba (57 commits)")[![samsonasik](https://avatars.githubusercontent.com/u/459648?v=4)](https://github.com/samsonasik "samsonasik (4 commits)")[![bbrala](https://avatars.githubusercontent.com/u/3294970?v=4)](https://github.com/bbrala "bbrala (1 commits)")[![eshimischi](https://avatars.githubusercontent.com/u/983201?v=4)](https://github.com/eshimischi "eshimischi (1 commits)")

---

Tags

generator

### Embed Badge

![Health badge](/badges/symplify-rule-doc-generator/health.svg)

```
[![Health](https://phpackages.com/badges/symplify-rule-doc-generator/health.svg)](https://phpackages.com/packages/symplify-rule-doc-generator)
```

###  Alternatives

[eightynine/filament-advanced-widgets

Advanced widgets for your filament php application

8971.7k](/packages/eightynine-filament-advanced-widgets)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)