solarium icon indicating copy to clipboard operation
solarium copied to clipboard

Add :void return to methods

Open thePanz opened this issue 7 months ago • 5 comments

First part of adding types coverage to the repository.

This was done by using Rector, and enabling only this rules

  • https://getrector.com/rule-detail/add-void-return-type-where-no-return-rector

\cc @thomascorthals @mkalkbrenner

thePanz avatar Jun 12 '25 20:06 thePanz

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 98.15%. Comparing base (9cdf3dd) to head (6d4e3b7). :warning: Report is 22 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1158      +/-   ##
==========================================
+ Coverage   97.75%   98.15%   +0.39%     
==========================================
  Files         400      404       +4     
  Lines       10524    10663     +139     
==========================================
+ Hits        10288    10466     +178     
+ Misses        236      197      -39     
Flag Coverage Δ
unittests 98.15% <100.00%> (+0.39%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jun 12 '25 20:06 codecov[bot]

I would apply this here as well for initPlugin()?

EDIT: You don't have a choice, that's what makes the tests fail. Which means it's necessary in the docs too so we don't lead users astray.

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/docs/customizing-solarium.md?plain=1#L269

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/examples/5.3.1-plugin-event-hooks.php#L13

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/examples/5.3.2-plugin-solarium-presets.php#L17

thomascorthals avatar Jun 12 '25 21:06 thomascorthals

And if it breaks existing customisations, it needs to go in the CHANGELOG and probably also here:

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/docs/getting-started.md?plain=1#L88-L91

thomascorthals avatar Jun 12 '25 22:06 thomascorthals

I would apply this here as well for initPlugin()?

EDIT: You don't have a choice, that's what makes the tests fail. Which means it's necessary in the docs too so we don't lead users astray.

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/docs/customizing-solarium.md?plain=1#L269

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/examples/5.3.1-plugin-event-hooks.php#L13

https://github.com/solariumphp/solarium/blob/894cedfd9e957fa30b225bdd0333ee9d1b7bebfb/examples/5.3.2-plugin-solarium-presets.php#L17

Thanks for the hints! Applied the changes to the code, examples. I added a mention to the CHANGELOG and the list of common pitfalls.

thePanz avatar Jun 13 '25 07:06 thePanz

ok to merge this one? WDYT @mkalkbrenner

thePanz avatar Jun 17 '25 15:06 thePanz