Contradicting rules for file header comment

[arueckauer]

Bug Report

Q	A
Versions	2.0.x

Summary

Rules WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment and PSR12.Files.FileHeader.IncorrectOrder contradict themselves, if the file header comment does not include both a @copyright and @license tag.

In this report the development.config.php.dist of the Mezzio Skeleton will serve as example.

Current behavior

Running phpcbf on the example file, will fix the violation of WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment and open the violation of PSR12.Files.FileHeader.IncorrectOrder at the same time.

How to reproduce

Detailed instructions are provided in arueckauer/strict-type-declaration-cs-issue. In summary run the following commands on development.config.php.dist.

1. phpcs: Fixable violation of WebimpressCodingStandard.Files.DeclareStrictTypes.BelowComment (the other violation is irrelevant for this issue).
2. phpcbf: Fixed: 2; Remaining: 1.
3. phpcs: Violation of PSR12.Files.FileHeader.IncorrectOrder

Expected behavior

Here I am not sure. Probably the file header comment should be always above the strict type declaration. But it is not clear to me...

[arueckauer]

For the sake of completeness, important input from @weierophinney in Chat:

Hm... For Laminas stuff, we do need that; it's part of our style-guide, to ensure that those elements are present in every code file. For third-party consumers of our CS, it would not be.
So, I'd argue that:

• If the rule about the docblock spacing is COMBINED with the copyright/license requirements, those should be separate rules.
• In non-Laminas code, users would then disable the copyright/license enforcement rule. (Which, if the answer to the first point is "no, they're separate", you could do now if you can figure out the rule name; the -vv switch will tell you that.)

Not sure, if I understand it correctly. Does this mean, for Laminas code this works as expected (no code change required/desired) and for non Laminas code an exception should be defined (e.g. add documentation on how to use)?

[geerteltink]

Fixed in #36

[arueckauer]

Thank you! 🤩

[arueckauer]

@geerteltink This issue is present again in 2.2.0. Do not understand how, but possibly related to the drop of file header rules.