README

A curated, ready-to-use Rector rule set for PHP 8.4+ projects.

Rector ships over 500 rules. Picking the useful ones — and re-checking them on every Rector release — is a recurring chore. This package does that curation for you: one import, 228 hand-picked rules, with every other rule Rector offers listed as skipped, so a new Rector release cannot add a rule nobody looked at.

Installation

composer require --dev pekral/rector-rules

Usage

Import the package's rector.php into your own configuration. Both Rector config styles work:

Rector 2 builder style

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([__DIR__ . '/src'])
    ->withSets([__DIR__ . '/vendor/pekral/rector-rules/rector.php']);

Closure style

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->import(__DIR__ . '/vendor/pekral/rector-rules/rector.php');
    $rectorConfig->paths([__DIR__ . '/src']);
};

Then run Rector:

# Preview the changes without touching a file
vendor/bin/rector process --dry-run

# Apply them
vendor/bin/rector process

Skipping a rule you disagree with

The set is opinionated. Turn off anything that does not fit your codebase:

return RectorConfig::configure()
    ->withPaths([__DIR__ . '/src'])
    ->withSets([__DIR__ . '/vendor/pekral/rector-rules/rector.php'])
    ->withSkip([
        // Disable a rule everywhere
        Rector\CodeQuality\Rector\CallLike\AddNameToBooleanArgumentRector::class,

        // …or only in specific paths
        Rector\Php82\Rector\Class_\ReadOnlyClassRector::class => [
            __DIR__ . '/src/Legacy',
        ],
    ]);

What is in the set

228 rules, grouped by what they do:

Area	Rules	What it covers
`TypeDeclaration`	54	Infer and add native parameter, property, and return types
`CodeQuality`	50	Simplify conditions, loops, and expressions
`DeadCode`	44	Remove unreachable code, unused variables, and redundant docblocks
`PHPUnit`	19	Modernise test syntax, attributes, and assertions
`TypeDeclarationDocblocks`	14	Narrow `array` docblocks that no native type can express
`Php53` – `Php86`	34	Upgrade syntax to newer PHP versions
Other	13	`Privatization`, `CodingStyle`, `EarlyReturn`, `Renaming`, `Unambiguous`

The authoritative list is rules/rules.php — a plain array of rule class names.

Curation model

File	Role
`rector.php`	Entry point — registers every rule from `rules/rules.php`
`rules/rules.php`	The 228 enabled rules (shipped)
`build/ignored-rules.php`	The 305 rules that do not ship (development only). 21 sit under a stated reason — deprecated in Rector, or waiting on PHP 8.5; the other 284 are grouped under a plain `// Ignored rules` heading
`build/find-missing-rules.php`	CI guard: fails if a rule is neither enabled nor listed as ignored (development only)

Because of that guard, every rule Rector adds in a new release shows up as a build failure until someone decides about it. Nothing is silently ignored.

build/, .github/, assets/, the dotfiles, and the repository-only documents (CHANGELOG.md, UPGRADING.md) are marked export-ignore, so composer require pulls down exactly five files: rector.php, rules/rules.php, composer.json, README.md, and LICENSE.

Requirements

	Version
PHP	`^8.4`
`rector/rector`	`^2.6.5`

Contributing to this repository needs PHP 8.5+, because the development dependencies require it. Using the package only needs 8.4.

Development

composer install

Command	What it does
`composer check`	Full check: code style, Rector dry-run, missing-rule guard
`composer fix`	Apply Rector and code-style fixes
`composer build`	`fix`, then `check`, then reinstall the AI agent rules
`composer phpcs` / `composer phpcs:fix`	Code style only
`composer rector` / `composer rector:fix`	Rector on this repository's own sources
`composer check:missing-rules`	Report rules that are neither enabled nor ignored
`composer ai-olympus:install`	Reinstall pekral/ai-olympus agent rules and skills

Adding a rule

Add the class to rules/rules.php, or to build/ignored-rules.php if it should stay off.
Run composer check.

composer check:missing-rules fails when a rule is in neither file, so every rule Rector ships has to be decided about.

See CONTRIBUTING.md for how the guard works and the reasons rules are left out.

CI

Pull requests and pushes to master run the same composer check steps plus a composer audit, and separately validate composer.json and lint the shipped sources on the declared minimum PHP 8.4. A weekly job refreshes dependencies and opens a PR; another audits dependencies for known vulnerabilities every Monday.

FAQ

How do I preview what would change? vendor/bin/rector process --dry-run.

How do I disable a single rule? Use withSkip() — see Skipping a rule you disagree with.

Can I combine this with Rector's own sets? Yes. Add ->withPhpSets() or any other set alongside withSets(). A rule that ends up registered twice is not an error.

Why is rule X not included? Check build/ignored-rules.php in the repository — every rule that does not ship is listed there. Rules deprecated in Rector, and those waiting on PHP 8.5, sit under a heading that says so; the rest are grouped under a plain // Ignored rules heading, which records the decision without a reason.

What happens when I upgrade? Most releases so far have changed the set, patch releases included, so Rector may rewrite more of your code than before. Run --dry-run first and read UPGRADING.md.

How do I contribute? Open an Enable a rule or Disable a rule issue, ask in Discussions, or send a pull request — see CONTRIBUTING.md.

License

MIT — see LICENSE.

Maintained by Petr Král.

pekral / rector-rules

Maintainers

Package info

Fund package maintenance!

Statistics

Security