Documentation and style changes to satisfy phpcs

Author: robtimus

.github/workflows/build.yml

@@ -47,6 +47,30 @@ jobs:
       - name: PHPStan
         run: phpstan analyse
 
+  phpcs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Set up PHP 7.4
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          tools: phpcs
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+      - name: Install dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+      - name: PHPCS
+        run: phpcs src/ tests/
+
   test:
     runs-on: ubuntu-latest
     strategy:

.gitignore

@@ -1,6 +1,8 @@
 /composer.lock
 /vendor/
-/.buildpath
-/.project
-/.settings
+/docs/
+
+/.phpunit.cache
+.phpunit.result.cache
+
 tests/config.json

phpcs.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<ruleset name="Robtimus">
+  <rule ref="PEAR">
+    <exclude name="PEAR.Commenting.FileComment"/>
+  </rule>
+  <rule ref="Generic.Commenting.DocComment">
+    <exclude-pattern>*/tests/*</exclude-pattern>
+  </rule>
+  <rule ref="Generic.Files.LineLength">
+    <properties>
+      <property name="lineLimit" value="150"/>
+    </properties>
+  </rule>
+  <rule ref="PEAR.Commenting.ClassComment">
+    <exclude-pattern>*/tests/*</exclude-pattern>
+  </rule>
+  <rule ref="PEAR.Commenting.ClassComment.MissingCategoryTag">
+    <exclude-pattern>*</exclude-pattern>
+  </rule>
+  <rule ref="PEAR.Commenting.ClassComment.MissingLinkTag">
+    <exclude-pattern>*</exclude-pattern>
+  </rule>
+  <rule ref="PEAR.Commenting.FunctionComment">
+    <properties>
+      <property name="minimumVisibility" value="protected"/>
+    </properties>
+    <exclude-pattern>*/tests/*</exclude-pattern>
+  </rule>
+</ruleset>