Skip to content

Validate @method docblock tag in CI #171

Closed
@emteknetnz

Description

Split off from #163

Acceptance criteria

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

Notes

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.

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions