feat: add option to report ignores without comments

[calebdw]

Hello!

Closes phpstan/phpstan#11340

This PR adds the following two option (false by default):

• reportIgnoresWithoutIdentifiers: reports @phpstan-ignore-line and @phpstan-ignore-next-line usages
• reportIgnoresWithoutComments: reports @phpstan-ignore usages without comments

Thanks!

[calebdw]

CI failures look to be unrelated

[NanoSector]

Thanks for providing this & also picking up the case for no comments 🙌

[ondrejmirtes]

I'm thinking about deprecating @phpstan-ignore-line and @phpstan-ignore-next-line completely now and removing them in 3.0. Because people often use them with identifiers by mistake, but these comments ignore all errors anyway. So I don't want to add reportIgnoresWithoutIdentifiers now.

We'd have to add a support for new comment @phpstan-ignore-all-errors to have a replacement for these though.

As for reportIgnoresWithoutComments, yeah, that one makes sense to me and I'd accept it.

[calebdw]

Sounds good---I'll update

We'd have to add a support for new comment @phpstan-ignore-all-errors to have a replacement for these though.

That's good---however, consider adding an option to enable/disable this when the new comment is added. Some projects may want to complete disable this and not allow such a global ignore

[derrabus]

I'm thinking about deprecating @phpstan-ignore-line and @phpstan-ignore-next-line completely now and removing them in 3.0. Because people often use them with identifiers by mistake, but these comments ignore all errors anyway. So I don't want to add reportIgnoresWithoutIdentifiers now.

A deprecation would also work for me. I want to rid my codebases of those annotations, so as long as an error pops up if one of the old annotations is used, I'm happy. ✌🏻

[calebdw]

@ondrejmirtes, this is ready for review 👍

[VincentLanglet]

That's good---however, consider adding an option to enable/disable this when the new comment is added. Some projects may want to complete disable this and not allow such a global ignore

This feel like a very special/opinionated rules which might make more sens in a dedicated repository or just in your personal project IMHO.

And there is already some way to achieve this like using PHP-CS-Fixer
https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/general_phpdoc_annotation_remove.rst
and configuring those tag as "to remove".

Certainly the same could exist with PHP CodeSniffer or Rector or any linter.

I personally think the same about reportIgnoresWithoutComments but I let ondrej decide