feature: create example workflow for greeter

Author: g105b

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: php-actions/composer@v6
+
+      - name: Mess Detector
+        uses: php-actions/phpmd@master
+        with:
+          php_version: 8.4
+          path: src/
+          output: text
+          ruleset: src/phpmd.xml

composer.json

@@ -0,0 +1,13 @@
+{
+	"name": "php-actions/example-phpmd",
+	"description": "Example project using php-actions/phpstan",
+
+	"require-dev": {
+		"phpmd/phpmd": "2.*"
+	},
+	"autoload": {
+		"psr-4": {
+			"App\\": "src"
+		}
+	}
+}

src/Greeter.php

@@ -0,0 +1,12 @@
+<?php
+namespace App;
+
+class Greeter {
+	public function greet(?string $name = null):string {
+		if($name) {
+			return "Hello, $name!";
+		}
+
+		return "Hello!";
+	}
+}

src/phpmd.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" ?>
+<ruleset name="PHP.Gt 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"
+	 xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+	<description>Custom ruleset</description>
+
+	<rule ref="rulesets/codesize.xml">
+	</rule>
+
+	<rule ref="rulesets/cleancode.xml">
+		<exclude name="BooleanArgumentFlag" />
+		<exclude name="ErrorControlOperator" />
+	</rule>
+
+	<rule ref="rulesets/controversial.xml">
+	</rule>
+
+	<rule ref="rulesets/design.xml">
+	</rule>
+
+	<rule ref="rulesets/naming.xml">
+		<exclude name="ShortVariable" />
+		<exclude name="ShortMethodName" />
+	</rule>
+
+	<rule ref="rulesets/unusedcode.xml">
+	</rule>
+
+	<rule ref="rulesets/naming.xml/ShortVariable">
+		<properties>
+			<property name="exceptions" value="id" />
+		</properties>
+	</rule>
+	<rule ref="rulesets/naming.xml/ShortMethodName">
+		<properties>
+			<property name="exceptions" value="gc" />
+		</properties>
+	</rule>
+</ruleset>