Merge pull request #48 from youwe-petervanderwal/feat/pimcore-phpmd

feat: pimcore phpmd config

Author: youwe-petervanderwal

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Pimcore coding standards with [PER coding standards](https://www.php-fig.org/per/coding-style/).
 - Added support for an Allow List within the Security Checker.
 - Pimcore PHPStan default config.
+- Pimcore PHP Mess Detector default config.
 
 ### Changed
 - [BREAKING] The composer.json configurations `config.youwe-testing-suite.type` and `config.mediact-testing-suite.type`

config/pimcore/phpmd.xml

@@ -21,15 +21,26 @@
     <rule ref="rulesets/codesize.xml" />
     <rule ref="rulesets/design.xml" />
     <rule ref="rulesets/unusedcode.xml" />
-    <rule ref="rulesets/naming.xml" />
+    <rule ref="rulesets/naming.xml">
+        <!-- For these rules we have exceptions configured below -->
+        <exclude name="LongVariable" />
+        <exclude name="ShortVariable" />
+        <exclude name="ShortMethodName" />
+    </rule>
 
     <rule ref="rulesets/naming.xml/LongVariable">
         <properties>
             <!-- 20 limit is hard to make descriptive, plus has historically been 30 so also for better backwards compatibility support -->
             <property name="maximum" value="30"/>
         </properties>
     </rule>
-    <!-- End of global ruleset -->
+
+    <!-- $id is a very common (and accepted) ShortVariable -->
+    <rule ref="rulesets/naming.xml/ShortVariable">
+        <properties>
+            <property name="exceptions" value="id" />
+        </properties>
+    </rule>
 
     <!-- up() is required for doctrine migrations when implementing the interface. -->
     <rule ref="rulesets/naming.xml/ShortMethodName">