From eb26ed4c065e3c10b0a198866c044aa823f62e56 Mon Sep 17 00:00:00 2001
From: Eike Starkmann <eike.starkmann@undkonsorten.com>
Date: Mon, 29 Jul 2024 19:36:34 +0200
Subject: [PATCH] [FEATURE] Add php mess detector

Resolves: #128
---
 Build/phpmd.xml | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 composer.json   |  2 ++
 2 files changed, 49 insertions(+)
 create mode 100644 Build/phpmd.xml

diff --git a/Build/phpmd.xml b/Build/phpmd.xml
new file mode 100644
index 00000000..ba653310
--- /dev/null
+++ b/Build/phpmd.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<ruleset name="phpList">
+    <description>
+        PHPMD rules for Tea
+    </description>
+
+    <!-- The commented-out rules will be enabled once the code does not generate any warnings anymore. -->
+
+    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
+    <rule ref="rulesets/cleancode.xml/StaticAccess"/>
+
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity"/>
+    <rule ref="rulesets/codesize.xml/NPathComplexity"/>
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength"/>
+    <!--<rule ref="rulesets/codesize.xml/ExcessiveClassLength"/>-->
+    <rule ref="rulesets/codesize.xml/ExcessiveParameterList"/>
+    <rule ref="rulesets/codesize.xml/ExcessivePublicCount"/>
+    <rule ref="rulesets/codesize.xml/TooManyFields"/>
+    <!--<rule ref="rulesets/codesize.xml/TooManyMethods"/>-->
+    <rule ref="rulesets/codesize.xml/TooManyPublicMethods"/>
+    <!--<rule ref="rulesets/codesize.xml/ExcessiveClassComplexity"/>-->
+
+    <rule ref="rulesets/controversial.xml/Superglobals"/>
+    <rule ref="rulesets/controversial.xml/CamelCaseClassName"/>
+    <rule ref="rulesets/controversial.xml/CamelCasePropertyName"/>
+    <rule ref="rulesets/controversial.xml/CamelCaseMethodName"/>
+    <rule ref="rulesets/controversial.xml/CamelCaseParameterName"/>
+    <rule ref="rulesets/controversial.xml/CamelCaseVariableName"/>
+
+    <rule ref="rulesets/design.xml/ExitExpression"/>
+    <rule ref="rulesets/design.xml/EvalExpression"/>
+    <rule ref="rulesets/design.xml/GotoStatement"/>
+    <rule ref="rulesets/design.xml/NumberOfChildren"/>
+    <rule ref="rulesets/design.xml/DepthOfInheritance"/>
+    <rule ref="rulesets/design.xml/CouplingBetweenObjects"/>
+    <rule ref="rulesets/design.xml/DevelopmentCodeFragment"/>
+
+    <rule ref="rulesets/naming.xml/ShortVariable"/>
+    <rule ref="rulesets/naming.xml/ShortMethodName"/>
+    <rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass"/>
+    <rule ref="rulesets/naming.xml/ConstantNamingConventions"/>
+    <rule ref="rulesets/naming.xml/BooleanGetMethodName"/>
+
+    <rule ref="rulesets/unusedcode.xml/UnusedPrivateField"/>
+    <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable"/>
+    <rule ref="rulesets/unusedcode.xml/UnusedFormalParameter"/>
+</ruleset>
diff --git a/composer.json b/composer.json
index 4808cce3..cb43f74c 100644
--- a/composer.json
+++ b/composer.json
@@ -52,6 +52,7 @@
 		"helmich/typo3-typoscript-lint": "^3.1.1",
 		"icanhazstring/composer-unused": "^0.8.11",
 		"php-coveralls/php-coveralls": "^2.7.0",
+		"phpmd/phpmd": "^2.15",
 		"phpstan/extension-installer": "^1.4.1",
 		"phpstan/phpstan": "^1.11.8",
 		"phpstan/phpstan-phpunit": "^1.4.0",
@@ -147,6 +148,7 @@
 		"ci:php:lint": "find .*.php *.php Classes Configuration Tests -name '*.php' -print0 | xargs -r -0 -n 1 -P 4 php -l",
 		"ci:php:sniff": "phpcs Classes Configuration Tests",
 		"ci:php:stan": "phpstan --no-progress",
+		"ci:php:mess": "phpmd Classes,Configuration,Tests text Build/phpmd.xml",
 		"ci:static": [
 			"@ci:composer:normalize",
 			"@ci:json:lint",