rector/rector-generator

Generate Rector rules from command line

0.6.15 2023-02-07 20:32 UTC

Requires

• php: >=8.1
• nette/utils: ^3.2
• nikic/php-parser: ^4.14
• symfony/console: ^6.2
• symfony/dependency-injection: ^6.1
• symfony/finder: ^6.2
• symplify/package-builder: ^11.1
• webmozart/assert: ^1.11

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.1
• phpstan/phpdoc-parser: ^1.6.4
• phpstan/phpstan-webmozart-assert: ^1.0
• phpunit/phpunit: ^10.0
• rector/rector: ^0.15.13
• symplify/coding-standard: ^11.0
• symplify/easy-ci: ^11.2.0
• symplify/easy-coding-standard: ^11.0
• symplify/phpstan-extensions: ^11.0
• symplify/phpstan-rules: ^11.0
• symplify/vendor-patches: ^11.0
• tracy/tracy: ^2.9

MIT

README

Every Rector rule requires test, test fixtures, config and the rule.

- rules/Package/Rector/Category/SomeRector.php

- rules-tests/Package/Rector/Category/SomeRector/SomeRectorTest.php
- rules-tests/Package/Rector/Category/SomeRector/config/confured_rule.php
- rules-tests/Package/Rector/Category/SomeRector/Fixture/some_fixture.php.inc

~80 % of the code is repeated text - namespace, Rector name, default test setup etc.

This package will save your typing the repeated code and gives you more space for writing refactor() method logic.

How to Generate a new Rule?

1. Initialize rector-recipe.php config

vendor/bin/rector init-recipe

1. Complete parameters in rector-recipe.php to design your new rule

2. Run command

vendor/bin/rector generate

That's it :)