Add phpmd to project

Author: jonatanrdsantosmcf

.github/workflows/tests.yml

@@ -75,5 +75,8 @@ jobs:
       - name: PHP CS Fixer
         run: composer lint:check
 
+      - name: PHP MD
+        run: composer phpmd
+
       - name: PHPstan
         run: composer phpstan

CONTRIBUTING.md

@@ -61,6 +61,8 @@ composer lint:check
 composer lint:fix
 # PHPstan
 composer phpstan
+# PHPMD
+composer phpmd
 ```
 
 ### Using the Docker Environment

composer.json

@@ -29,6 +29,7 @@
   "require-dev": {
     "doctrine/annotations": "^2.0",
     "doctrine/orm": "^2.9",
+    "phpmd/phpmd": "^2.13",
     "matthiasnoback/symfony-dependency-injection-test": "^4.3",
     "nyholm/psr7": "^1.5.1",
     "php-cs-fixer/shim": "^3.14",
@@ -62,6 +63,7 @@
     }
   },
   "scripts": {
+    "phpmd": "./vendor/bin/phpmd src text phpmd.xml",
     "phpstan": "./vendor/bin/phpstan --memory-limit=1G --ansi",
     "test:unit": "./vendor/bin/phpunit --colors=always --verbose",
     "test:unit:coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --colors=always --coverage-html=tests/coverage",

phpmd.baseline.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<phpmd-baseline>
+  <violation rule="PHPMD\Rule\CleanCode\IfStatementAssignment" file="src/Command/IndexCommand.php" method="getEntitiesFromArgs"/>
+  <violation rule="PHPMD\Rule\CleanCode\ElseExpression" file="src/Command/MeiliSearchClearCommand.php"/>
+  <violation rule="PHPMD\Rule\CyclomaticComplexity" file="src/Command/MeiliSearchCreateCommand.php" method="execute"/>
+  <violation rule="PHPMD\Rule\CyclomaticComplexity" file="src/Command/MeiliSearchImportCommand.php" method="execute"/>
+  <violation rule="PHPMD\Rule\Design\NpathComplexity" file="src/Command/MeiliSearchImportCommand.php" method="execute"/>
+  <violation rule="PHPMD\Rule\Design\CountInLoopExpression" file="src/Command/MeiliSearchImportCommand.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\ElseExpression" file="src/Command/MeiliSearchImportCommand.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\IfStatementAssignment" file="src/DependencyInjection/MeiliSearchExtension.php" method="load"/>
+  <violation rule="PHPMD\Rule\Naming\LongVariable" file="src/DependencyInjection/MeiliSearchExtension.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\ElseExpression" file="src/DependencyInjection/MeiliSearchExtension.php"/>
+  <violation rule="PHPMD\Rule\Naming\ShortVariable" file="src/Engine.php"/>
+  <violation rule="PHPMD\Rule\Naming\LongVariable" file="src/Model/Aggregator.php"/>
+  <violation rule="PHPMD\Rule\Naming\ShortVariable" file="src/SearchableEntity.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\ElseExpression" file="src/SearchableEntity.php"/>
+  <violation rule="PHPMD\Rule\Design\TooManyPublicMethods" file="src/Services/MeiliSearchService.php"/>
+  <violation rule="PHPMD\Rule\Design\CouplingBetweenObjects" file="src/Services/MeiliSearchService.php"/>
+  <violation rule="PHPMD\Rule\Naming\LongVariable" file="src/Services/MeiliSearchService.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\StaticAccess" file="src/Services/MeiliSearchService.php"/>
+  <violation rule="PHPMD\Rule\Naming\ShortVariable" file="src/Services/MeiliSearchService.php"/>
+  <violation rule="PHPMD\Rule\CleanCode\ElseExpression" file="src/Services/MeiliSearchService.php"/>
+</phpmd-baseline>

phpmd.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>Ruleset for PHP Mess Detector that enforces coding standards</description>
+    <rule ref="rulesets/cleancode.xml"/>
+    <rule ref="rulesets/codesize.xml"/>
+    <rule ref="rulesets/controversial.xml"/>
+    <rule ref="rulesets/design.xml"/>
+    <rule ref="rulesets/naming.xml"/>
+    <rule ref="rulesets/unusedcode.xml"/>
+</ruleset>