Add Rector #2
Add Rector #2
Conversation
|
@samsonasik See what you think of this. Based on the version from the CI4 repo with the "utility" classes and file references removed. Once PHP 7.4 is the minimum we can update some of these rule sets to be more inclusive. |
src/rector.php
Outdated
|
|
||
| // do you need to include constants, class aliases or custom autoloader? files listed will be executed | ||
| $parameters->set(Option::BOOTSTRAP_FILES, [ | ||
| realpath(getcwd()) . '/vendor/autoload.php', |
There was a problem hiding this comment.
vendor/autoload.php can be in Option::AUTOLOAD_PATHS, ref https://github.com/rectorphp/rector/blob/main/docs/static_reflection_and_autoload.md#static-reflection-and-autoload
There was a problem hiding this comment.
That actually makes me think that we don't need to reference the autoload file at all, right?
There was a problem hiding this comment.
I removed the Composer path altogether (it seems like Rector finds this on its own) and cleaned the config file up a bunch. Re-review please?
src/.github/workflows/rector.yml
Outdated
|
|
||
| - name: Analyze for refactoring | ||
| run: | | ||
| composer global require --dev rector/rector:^0.12.4 |
There was a problem hiding this comment.
better to have pinned version so we can verify every version to verify bug fix, like in codeigniter4/CodeIgniter4#5328 (comment)
| composer global require --dev rector/rector:^0.12.4 | |
| composer global require --dev rector/rector:0.12.4 |
There was a problem hiding this comment.
I'm not sure how to handle this one. The goal is for these to be templates that developers can merge into their own repos and then adjust as necessary. I don't want us to have to keep updating this repo every time there is a new minor patch to Rector. Maybe we reference the minor version ^0.12 and add a note to the docs that developers should consider locking it to the specific patch?
There was a problem hiding this comment.
I rolled it back to the unspecified version and added a note in the docs; see what you think.
| // The paths to refactor (can also be supplied with CLI arguments) | ||
| $parameters->set(Option::PATHS, [ | ||
| __DIR__ . '/app', | ||
| __DIR__ . '/tests', |
There was a problem hiding this comment.
is this not used in CodeIgniter4 project as not check system dir?
There was a problem hiding this comment.
The intent is not for this to be used in the framework repo but distributable to developer's projects and libraries. Libraries will need to adjust the path from app/ to src/ (or whatever they use), but that is the case for all the files in this repo and I hope to make a scripted solution down the road.
| @@ -130,6 +130,9 @@ predefined rulesets. Rector can be highly opinionated based on its configuration | |||
| so be sure to read the documentation and figure out the best fit for you. This workflow performs | |||
| a "dry run" to check for any changes that Rector would have made and fail if there are matches. | |||
|
|
|||
| > Note: Rector updates rules all the time so you may want to lock your repo to the latest known working version of Rector to prevent unexpected failures | |||
| > E.g. in **.github/workflows/rector.yml** supply the specific minor patch: `composer global require --dev rector/rector:0.12.4` | |||
|
|
|||
No description provided.