build: #2 phpcs and phpmd

Author: shaunthegeek

.git-pre-commit

@@ -0,0 +1,9 @@
+#!/bin/sh
+set -e
+
+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
+done
+./vendor/bin/phpunit tests/

composer.json

@@ -9,13 +9,20 @@
     },
     "require-dev": {
         "fakerphp/faker": "^1.16",
-        "phpunit/phpunit": "^9.5"
+        "phpmd/phpmd": "^2.10",
+        "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.6"
     },
     "license": "Apache-2.0",
     "autoload": {
         "psr-4": { "Coding\\": "src/" }
     },
     "autoload-dev": {
         "psr-4": { "Coding\\Tests\\": "tests/" }
+    },
+    "scripts": {
+        "post-install-cmd": [
+            "php -r \"if (is_dir('.git/hooks/')) {copy('.git-pre-commit', '.git/hooks/pre-commit'); chmod('.git/hooks/pre-commit', 0755);}\""
+        ]
     }
 }

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>