IBX-8117: Prepared Rector package #1
Merged
Conversation
This file contains 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
alongosz
force-pushed
the
ibx-8117-prepare-rector-package
branch
from
2fb6ad2
to
121bf48
Compare
adamwojs
approved these changes
May 9, 2024
tests/lib/Composer/Command/CustomRule/RectorTemplateContentsProcessorTest.php
Outdated
Show resolved
Hide resolved
Co-authored-by: Adam Wójs <adam@wojs.pl>
Steveb-p
reviewed
May 10, 2024
Steveb-p
reviewed
May 10, 2024
src/lib/Composer/Command/CustomRule/AbstractRectorTemplateProcessor.php
Outdated
Show resolved
Hide resolved
Co-Authored-By: Paweł Niedzielski <Steveb-p@users.noreply.github.com>
Co-Authored-By: Paweł Niedzielski <Steveb-p@users.noreply.github.com>
Steveb-p
approved these changes
May 10, 2024
konradoboza
approved these changes
May 10, 2024
|
|
||
| ## Creating custom rules | ||
|
|
||
| This package comes with a Composer-wrapped Symfony command to generate custom rule and place its files to proper |
There was a problem hiding this comment.
Suggested change
| This package comes with a Composer-wrapped Symfony command to generate custom rule and place its files to proper | |
| This package comes with a Composer-wrapped Symfony command to generate custom rule and place its files in proper |
There was a problem hiding this comment.
Sorry, missed this. Fixed via ee2b174 on main, thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
This PR provides some skeleton which adapts https://github.com/rectorphp/rector to our needs.
Changes:
rector/rectorv1nikic/php-parser^4due to php-parser v5 compat rectorphp/rector#8567.define-custom-ruleand necessary processors, based on built-in Rectorcustom-rulecommand, utilizing rector-provided templatesBackground: built-in command is not very flexible and does too much, adding our custom command based on the built-in seemed like the most sane approach (though required not small portion of code). Road explored: wrap it and move files afterwards, but that doesn't provide the best DX as the command messes with composer and PHPUnit configuration...
Please note that this is executed by
composer define-custom-ruleso there's no Symfony DI involved there, nor bundle requirement. It makes it more compact and easier to install and use, though it's something that can be changed, depending on the preferences.For QA:
Rather no QA at this point.
Documentation:
All needed information were documented here. Due to the nature of this package IMHO it makes more sense to do it here, however we can still either reference this in the Official Doc or move it and reference Official Doc here.