Contributing custom rules for Ibexa DXP

This guide is meant for adding rules to this package. For custom project rules, it's recommended to follow Rector's official documentation.

Structure

• ./src/contracts/Sets - directory to add global rulesets
  • ./src/contracts/Sets/ibexa-50.php is a ruleset which contains all the rules for Ibexa DXP 5.0 upgrade, new rules should be added there.
• ./src/lib/Rule - directory to implement specific rules, following Rector's official doc.
  • ./src/lib/Rule/Ibexa50/ - directory to implement Ibexa 5.0 upgrade specific rules.
• ./tests/lib/Rule - directory to implement a specific rule tests, should contain subdirectory named <RuleName>/.
• ./tests/lib/Sets/Ibexa50/ - directory to implement specific use cases for Ibexa 5.0 set configuration, if not covered by Rector tests.

Creating custom rules

This package comes with a Composer-wrapped Symfony command to generate custom rule and place its files in proper directories, following the above structure.

composer define-custom-rule [<RuleNamespace>/]<RuleName>

For example, to add Ibexa v5.0 refactoring rule called Foo, execute:

composer define-custom-rule Ibexa50/Foo