feat: #16 phpmd

Author: shaunthegeek

composer.json

@@ -29,9 +29,10 @@
     },
     "minimum-stability": "stable",
     "require": {
+        "ext-json": "*",
         "laravel/framework": ">=v6.18.38",
-        "squizlabs/php_codesniffer": "^3.5",
-        "ext-json": "*"
+        "phpmd/phpmd": "^2.10",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "require-dev": {
         "orchestra/testbench": ">=v4.8.0"

src/LintPublishCommand.php

@@ -2,7 +2,6 @@
 
 namespace LaravelFans\Lint;
 
-use FilesystemIterator;
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\File;
 
@@ -32,6 +31,7 @@ public function handle()
         $basePath = $this->laravel->basePath();
 
         File::copy(__DIR__ . '/stubs/phpcs.xml', $basePath . '/phpcs.xml');
+        File::copy(__DIR__ . '/stubs/phpmd.xml', $basePath . '/phpmd.xml');
         if (File::exists($basePath . '/.git/hooks')) {
             File::copy(__DIR__ . '/stubs/git-pre-commit', $basePath . '/.git/hooks/pre-commit');
             File::chmod($basePath . '/.git/hooks/pre-commit', 0755);

src/stubs/git-pre-commit

@@ -1,7 +1,8 @@
 #!/bin/sh
 
-files=$(git diff --diff-filter=d --name-only HEAD | grep ".php$")
-
-if [ -n "$files" ] ; then
-	./vendor/bin/phpcs --standard=phpcs.xml $files
-fi
+FILES=$(git diff --diff-filter=d --name-only HEAD | { grep '.php$' || true; })
+for file in $FILES; do
+  ./vendor/bin/phpcs --extensions=php --standard=PSR12 "$file"
+  ./vendor/bin/phpmd "$file" text phpmd.xml --exclude vendor
+done
+# XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text --coverage-filter=app/ tests/

src/stubs/phpmd.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<pmd>
+    <rule ref="rulesets/cleancode.xml">
+        <exclude name="StaticAccess" />
+    </rule>
+
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/controversial.xml" />
+    <rule ref="rulesets/design.xml" />
+
+    <rule ref="rulesets/naming.xml">
+        <exclude name="ShortVariable" />
+    </rule>
+
+    <rule ref="rulesets/naming.xml/ShortVariable"
+          since="0.2"
+          message="Avoid variables with short names like {0}. Configured minimum length is {1}."
+          class="PHPMD\Rule\Naming\ShortVariable"
+          externalInfoUrl="http://phpmd.org/rules/naming.html#shortvariable">
+        <priority>3</priority>
+        <properties>
+            <property name="minimum" description="Minimum length for a variable, property or parameter name" value="3"/>
+            <property name="exceptions" value="id,q,w,i,j,k,v,e,f,fp" />
+        </properties>
+    </rule>
+
+    <rule ref="rulesets/unusedcode.xml" />
+</pmd>

tests/LintPublishCommandTest.php

@@ -12,6 +12,7 @@ public function testGitNotExists()
         File::deleteDirectory($laravelPath . '/.git/', true);
         $this->artisan('lint:publish')->run();
         $this->assertFileExists($laravelPath . '/phpcs.xml');
+        $this->assertFileExists($laravelPath . '/phpmd.xml');
         $this->assertFileDoesNotExist($laravelPath . '/.git/hooks/pre-commit');
     }
 
@@ -21,6 +22,7 @@ public function testGitExists()
         File::makeDirectory($laravelPath . '/.git/hooks/', 0755, true);
         $this->artisan('lint:publish')->run();
         $this->assertFileExists($laravelPath . '/phpcs.xml');
+        $this->assertFileExists($laravelPath . '/phpmd.xml');
         $this->assertFileExists($laravelPath . '/.git/hooks/pre-commit');
     }
 }