feat: add WordPress ruleset

Author: mrewers

GPA-Lab-WordPress/ruleset.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+<ruleset
+  name="GPA Lab WordPress"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"
+>
+
+  <description>
+    A modified version of the WordPress PHP coding standard.
+  </description>
+
+  <arg name="colors"/>
+  <arg name="extensions" value="php" />
+  <arg value="s"/>
+
+  <!-- Identify PHP cross-version compatibility issues in projects based on the WordPress CMS -->
+  <rule ref="PHPCompatibilityWP" />
+
+  <!-- Include the three WordPress coding standards rulesets. -->
+  <rule ref="WordPress-Core" />
+  <rule ref="WordPress-Docs" />
+  <rule ref="WordPress-Extra" />
+
+  <!-- Exclude unwanted rules from the Wordpress ruleset. -->
+  <rule ref="WordPress">
+    <exclude name="Generic.WhiteSpace.DisallowSpaceIndent" />
+    <exclude name="WordPress.Arrays.ArrayIndentation.ItemNotAligned" />
+    <exclude name="WordPress.Arrays.ArrayIndentation.MultiLineArrayItemNotAligned" />
+    <exclude name="WordPress.WhiteSpace.PrecisionAlignment" />
+  </rule>
+
+  <!-- Override indent settings to default to two spaces. -->
+  <rule ref="Generic.WhiteSpace.ScopeIndent">
+    <properties>
+      <property name="indent" value="2"/>
+      <property name="tabIndent" value="false"/>
+    </properties>
+  </rule>
+
+  <rule ref="PEAR.Functions.FunctionCallSignature">
+    <properties>
+      <property name="requiredSpacesAfterOpen" value="1"/>
+      <property name="requiredSpacesBeforeClose" value="1"/>
+      <property name="indent" value="2"/>
+      <property name="allowMultipleArguments" value="false"/>
+    </properties>
+  </rule>
+
+</ruleset>

composer.json

@@ -11,5 +11,10 @@
     "php": "^7.2 || ^8.0",
     "squizlabs/php_codesniffer": "^3.6.2",
     "phpcsstandards/phpcsextra": "^1.0"
+  },
+  "suggest": {
+    "phpcompatibility/php-compatibility": "Required when using the GPA-Lab-WordPress standard",
+    "phpcompatibility/phpcompatibility-wp": "Required when using the GPA-Lab-WordPress standard",
+    "wp-coding-standards/wpcs": "Required when using the GPA-Lab-WordPress standard"
   }
 }