[5.4] Document the patch type functionality of the DebugClassLoader #15802
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
wouterj
commented
Sep 12, 2021
There was a problem hiding this comment.
Nice, thank again :)
We might want to tell about #[ReturnTypeWillChange] since the script is also able to add them according to what PHP 8.1 reports
The script won't miss any spot (or that's a bug), but it doesn't really care about CS nor parse errors. We might want to tell ppl to review the patch and suggest to use php-cs-fixer after the script ran.
cc9df2f to
89c9b45
Compare
acrobat
reviewed
Sep 13, 2021
derrabus
added a commit
to symfony/symfony
that referenced
this pull request
Sep 13, 2021
…tions (wouterj) This PR was merged into the 5.4 branch. Discussion ---------- [ErrorHandler] Add helper script to patch type declarations | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | symfony/symfony-docs#15802 While trying out the patch functionality in my bundle (and simultaneously writing docs for it), I found that I would pretty much recommend to copy-paste the `.github/patch-types.php` script. So I made it a bit more generic and added it as an official script to the ErrorHandler component. Usage: ``` # important! $ composer dump-autoload -o # default usage $ ./vendor/bin/patch-type-declarations # if you're an OSS maintainer, you probably want: $ SYMFONY_PATCH_TYPE_DECLARATIONS="force=1&php=7.4" ./vendor/bin/patch-type-declarations # regex if you need to exclude a certain directory or class (defaults to "vendor/" by default) $ SYMFONY_PATCH_TYPE_EXCLUDE="{/vendor/|/path/to/excluded/}" ./vendor/bin/patch-type-declarations ``` For reference: I did not remove the `.github/patch-type.php` script. I don't think it's worth replacing all the exclusion rules in that script with a single regex. `@nicolas`-grekas please let me know if you think this makes sense (or if I'm interpreting the new functionality completely wrong). Commits ------- 9e6da7e [ErrorHandler] Add helper script to patch type declarations
89c9b45 to
ea5e392
Compare
ea5e392 to
0b2af4d
Compare
0b2af4d to
fbf0adf
Compare
|
Sorry for jumping the gun a bit here, but I would really like this to be online tomorrow. Nicolas and Javier have looked at these changes and weren't completely opposed to them 😉 But if anyone has any improvements left, I'm happy to look at your PR. |
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.
This is a critical bit of functionality that we have to explain before the stabilization phase, in order to document for open source maintainers how to make their packages compatible with Symfony 6. When 6.0 is released, it is also an important feature to smooth upgrading for application users. This is why the main text focuses on application, and I added a special sidebar for OSS maintainers.
I wasn't sure about the location for this functionality, but I think it makes most sense in the "upgrade major" article (although it used to be a very generic document).
@nicolas-grekas and @derrabus as far as I know, you two have been most involved in this process. Please, if you have time, validate that feature is described correctly and that the "Recommended approach for OSS maintainers" is actually the recommended one :D
Ref symfony/symfony#42988