Validate @method docblock tag in CI

emteknetnz commented 11 months ago

Split off from https://github.com/silverstripe/.github/issues/163

Acceptance criteria

[x] Missing @method annotations are picked up by CI (e.g. using phpstan or psalm)
[x] Extra @method annotations that don't relate to anything on the class are picked up by CI (e.g. using phpstan or psalm)
[x] Update PHP Codding standards to mentioned @method annotation.
[x] All supported modules run this new check in CI for their CMS 5 compatible versions (not CMS 4)

Notes

This will need to handle get_extra_config() in extensions (see https://github.com/silverstripe/silverstripe-framework/pull/11092#discussion_r1424737200)
https://github.com/syntro-opensource/silverstripe-phpstan has some useful code to take inspiration from
I've created https://github.com/silverstripe/silverstripe-standards for this to live in
There's an error running phpstan against some classes in framework - see https://github.com/phpstan/phpstan/issues/10509

PRs

Note: After merging the below, reassign to Guy so they can add this to packagist and roll it out to all the CMS 5 supported modules

Module Standardiser PRs

Note: For any PR that had outstanding PHPLint issues, I've manually fixed whatever needed to be fixed as a separate commit. Note that these had to be run against the 5 (or equivalent) branches because the @method annotation rule doesn't work correctly against the codebase if the generic types aren't available - and those were merged into the 5 (or equivalent) branches.

GuySartorelli commented 10 months ago

In order for the types to correctly resolve with PHPStan analysis of the existing @method annotations, we need generics in place. This is necessary to validate that the existing annotations are correct.

GuySartorelli commented 9 months ago

@emteknetnz seems like you're reviewing this so assigning to you

silverstripe / .github