Configure "SlevomatCodingStandard.Commenting.AnnotationName" rule

[phansys]

See:

• [CS] Apply SlevomatCodingStandard.Commenting.AnnotationName rule dbal#6015;
• SlevomatCodingStandard.Commenting.AnnotationName: New sniff to check incorrect annotation names slevomat/coding-standard#1557

TODO:

• Add test.

[kukulich]

Btw the sniff checks a lot more annotations :)

[phansys]

Yes, of course. But it was added here just for @inheritDoc.

[kukulich]

Yes, but the comment is not true because the sniff is not configured to solve just “inheritDoc”

[phansys]

That's right. I guess I can improve it.

[phansys]

I can not manage the test suite to have a green build. Do you know what is the issue? There seems that @inheritdoc is completely removed here: https://github.com/doctrine/coding-standard/pull/311/checks#step:6:77.

[greg0ire]

You have to update the patch files, it's notoriously hard. I've documented how to do so here: https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html#testing

[phansys]

You have to update the patch files, it's notoriously hard. I've documented how to do so here: https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html#testing

I followed these docs, but as these processes were failing, I thought it was part of the same issue:

make update-compatibility-patch-80
error: patch failed: tests/expected_report.txt:52
error: tests/expected_report.txt: patch does not apply
make: *** [Makefile:33: update-compatibility-patch-80] Error 1

[greg0ire]

Yes. Here, you are trying to apply a patch on expected_report, which you touched. I think you can edit the patch to remove the part about the expected_report.txt, edit phpcs.xml.dist to set the php version to 80000

then run vendor/bin/phpcs $(find tests/input/* | sort) --report=summary --report-file=tests/expected_report.txt

Then you press y to indicate you're done with the changes.

Hopefully there is an easier way but that's how I do it. @simPod , maybe you know of a simpler way?

[greg0ire]

I see you're making progress, and that's great, but I think you should make sure the 8.1 build passes before working on the 8.0 build, because it might involve touching expected_report.txt, and then you will have to touch the patch files again because of that.

[phansys]

Thank you so much for the hints.

[greg0ire]

Every time I merge something on this repo, I notice it is on the wrong branch right after merging 🤦‍♂️

[greg0ire]

Let's use the same solution as every time: I'll merge this up into 12.0.0, and then release it, that way there won't be a new 11.x

Anyway, thanks for the new contribution @phansys and congrats on managing this green build 👍

[phansys]

Which branch should I have used as target?

[greg0ire]

I documented the process here: https://www.doctrine-project.org/projects/doctrine-coding-standard/en/11.0/reference/index.html#versioning

It's not quite the same as a regular library. Don't worry though, it won't be hard to fix :)

[greg0ire]

it won't be hard to fix

Actually, merging up is going to be quite hard, since I introduced another rule on 12.0.x. Let me try.

[phansys]

Anyway, thanks for the new contribution @phansys and congrats on managing this green build +1

I gave up about the patch updates in my environment because setting the testVersion option at phpcs.xml.dist was not enough to have the proper changes for each PHP version; so, instead of pulling different images on my environment I've opted by dump the required changes in the CI pipeline.

Actually, merging up is going to be quite hard, since I introduced another rule on 12.0.x. Let me try.

There is no problem. Let me know if you prefer a new PR against 12.0.x. as now I can reproduce the steps that I've used for this PR.

[greg0ire]

If you feel like up to doing the merge up, that would be awesome! I don't remember if you did them with Sonata, but here it's the same method:

git fetch --all
git switch 12.0.x
git merge doctrine/11.1.x
# fix conflicts
git push fork 12.0.x

And then you do a pull request.

[phansys]

Sure. Let me try 👍

[phansys]

Here is the PR merging 11.1.x into 12.0.x: #314.