Allow using a canonical dist file #7845
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samsonasik
reviewed
Jan 20, 2026
| { | ||
| public const string DEFAULT_CONFIG_FILE = 'rector.php'; | ||
|
|
||
| public const string DEFAULT_DIST_CONFIG_FILE = 'rector.dist.php'; |
Member
There was a problem hiding this comment.
is common fallback file has .php.dist instead of .dist.php?
Contributor
Author
There was a problem hiding this comment.
I prefer the .dist.php format because IDEs will automatically recognise them as PHP files. Some tools like phpunit only support the xml.dist format. Others like phpstan support both. PHP-CS-Fixer supports .dist.php. So it seems that there is not a full consensus on this.
I can change this (or support both options) if needed, please let me know
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Most code quality/testing tools allow you to have a "canonical" (dist) config file which is stored in the repository and a local config file which replaces/extends the canonical file, allowing you to have a base configuration which is shared by all users and which can be overridden locally
This PR adds this capability to Rector. Rector will load a rector.php file if it exists but will also use a rector.dist.php file if the rector.php file does not exist
Adds two new end-to-end tests that check this new functionality