Add PHPStan level 5

[devnix]

Hi @oscarotero, I propose to add PHPStan slowly to improve the type coverage.

It may trigger some architectural questions, for example we are getting this error at level 0:

 ------ ----------------------------------------------------------------------------------- 
  Line   src/Flags.php                                                                      
 ------ ----------------------------------------------------------------------------------- 
  21     Unsafe usage of new static().                                                      
         🪪  new.static                                                                      
         💡 See: https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static   
 ------ ----------------------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------------------- 
  Line   src/Headers.php                                                                    
 ------ ----------------------------------------------------------------------------------- 
  26     Unsafe usage of new static().                                                      
         🪪  new.static                                                                      
         💡 See: https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static   
 ------ ----------------------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------------------- 
  Line   src/References.php                                                                 
 ------ ----------------------------------------------------------------------------------- 
  21     Unsafe usage of new static().                                                      
         🪪  new.static                                                                      
         💡 See: https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static   
 ------ ----------------------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------------------- 
  Line   src/Translation.php                                                                
 ------ ----------------------------------------------------------------------------------- 
  30     Unsafe usage of new static().                                                      
         🪪  new.static                                                                      
         💡 See: https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static   
 ------ ----------------------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------------------- 
  Line   src/Translations.php                                                               
 ------ ----------------------------------------------------------------------------------- 
  25     Unsafe usage of new static().                                                      
         🪪  new.static                                                                      
         💡 See: https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static   
 ------ -----------------------------------------------------------------------------------

It's not a big deal to fix, but making the class or the constructor final would be a breaking change, and I have no idea if it follows how you want to keep evolving this library.

[devnix]

Of course, @phpstan-consistent-constructor could be used, but making those classes final doesn't sound stupid to me

[oscarotero]

Hi @devnix
Thanks for this! I really appreciate your work.

I don't want to introduce breaking changes so @phpstan-consistent-constructor sounds good to me.
Let me know when it's ready to merge and I'll review it.

[devnix]

Thank you! I'm goint to iterate a little bit and I'll ask you a couple of specific questions here and there around the code 😄

[devnix]

@oscarotero, is the src/Scanner/FunctionsHandlersTrait.php still useful? PHPStan detects it's not used in any class or tested at all, so I'd like to know if it's an untested utility for the library consumer or a leftover.

[devnix]

Also, I'm wondering if you would be OK with adding Rector in another pull request so it can help reach PHPStan level 6 faster, applying each ruleset in granular pull requests.

[oscarotero]

is the src/Scanner/FunctionsHandlersTrait.php still useful? PHPStan detects it's not used in any class or tested at all, so I'd like to know if it's an untested utility for the library consumer or a leftover.

It's used by other packages, like PHP-Scanner.

[oscarotero]

Also, I'm wondering if you would be OK with adding Rector in another pull request so it can help reach PHPStan level 6 faster, applying each ruleset in granular pull requests.

I'm not familiarized with Rector but if it helps to improve the code quality, it's okay, as long as it keeps compatibility with PHP 7.2 and newer

[devnix]

I'm not familiarized with Rector but if it helps to improve the code quality, it's okay, as long as it keeps compatibility with PHP 7.2 and newer

Excellent!

The pull request should be ready to pass the workflows and be reviewed. Thank you!

[devnix]

It looks like PHPStan will not be installed in versions lower than 7.4. It should not pose a problem since it's just a devDependency.

I guess we could invoke PHPStan from Docker and remove the dependency

[oscarotero]

Can we use 1.x for these versions? I mean ^1 | ^2.

[devnix]

I'm unsure about the differences we will find by running it on different major PHP versions, which can be an interesting check. Can we check the CI again?

[devnix]

I think there is a conflict between the versions shipped into my machine of php-cs-fixer and phpcs, as there is no composer.lock for the project currently:

---

Also, I'm aware that it's well-known that running php-cs-fixer with different PHP versions can bring very different behaviors, so I might have a couple of suggestions that I can address here or in another pull request if you want:

• Persisting a composer.lock in the repository to have predictable versions of the development packages
• Run style checkers together, as well as running both fixers in the same fix command too
• Run style checkers only on the lowest supported version maybe?
• I think I would worry more about running the test matrix only for PHPUnit, and have separate workflows for PHPStan and the coding style

[devnix]

Workflows should be green now: https://github.com/devnix/Gettext/actions/runs/14604976659/job/40971880629?pr=1

[oscarotero]

Great work! Thanks you!