-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[ErrorHandler] Add helper script to patch type declarations #42988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
6364d3c
to
1a799e1
Compare
Hey! I think @fancyweb has recently worked with this code. Maybe they can help review this? Cheers! Carsonbot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this PR, I had something similar on my list!
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations
Outdated
Show resolved
Hide resolved
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations.php
Outdated
Show resolved
Hide resolved
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations.php
Outdated
Show resolved
Hide resolved
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations.php
Outdated
Show resolved
Hide resolved
0f8b7c1
to
8311f21
Compare
PR updated, including the proposed changes. Also added some help information, and added a basic deprecation handling (I don't want to depend on PhpUnitBridge - but it's still good to show type deprecations imho). |
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations
Outdated
Show resolved
Hide resolved
src/Symfony/Component/ErrorHandler/Resources/bin/patch-type-declarations
Outdated
Show resolved
Hide resolved
8311f21
to
4467659
Compare
4467659
to
9e6da7e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
As a follow-up, I think it would be great if we could eat our own dogfood here and leverage that script of yours in our CI.
Thank you Wouter. |
…ugClassLoader (wouterj) This PR was merged into the 5.4 branch. Discussion ---------- [5.4] Document the patch type functionality of the DebugClassLoader 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 Commits ------- fbf0adf Document DebugClassLoader type patch functionality
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:
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).