PHPMD: added basic config

[sreichel]

Description (*)

Last tool to add ... PHPMD

• added composer (dev) dependency (already there)
• added default config file
• suppress error message for @ operator

Todo (new PRs)

• add inline-comments for common errors
  • ErrorControlOperator (this PR)
  • UnusedFormalParameter (PHPMD: suppressed warning for unused parameters #2786 )
• add baseline file
• add to github workflow

Test

vendor/bin/phpmd app/code/core/Mage/ text .phpmd.dist.xml

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)
• Add yourself to contributors list

[fballiano]

do we need it? does things that phpstan does not? because now we're adding a lot of "suppress warning" which... I don't like.

wait a sec

[sreichel]

do we need it?

Do we need codesyle checks or phpstan? Imho phpmd is a great tool to improve code.

does things that phpstan does not?

Yes. Its completly different. phpstan checks for working code, phpmd for clean (not messed up) code.

because now we're adding a lot of "suppress warning" which... I don't like.

Add "suppress warning" shows that the "problematic" code is intentional - or needs to be reviewed.

I'd like to enable checks step by step ... regardless of adding some lines to phpdocs.

[fballiano]

ok I see, but still, we're not going to add "suppresswarning" to every method just to remove it later one by one right?

[sreichel]

Nope. It should only be added for code that cant be changed.