Set of code standard rules to check underlying code

phpcs.xml.dist

@@ -0,0 +1,120 @@
+<?xml version="1.0"?>
+<ruleset name="WordPress Plugin Coding Standards">
+    <!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
+    <!-- See https://github.com/WordPress/WordPress-Coding-Standards -->
+    <!-- See https://github.com/PHPCompatibility/PHPCompatibilityWP -->
+
+    <!-- Set a description for this ruleset. -->
+    <description>A custom set of code standard rules to check for WordPress plugins.</description>
+
+
+    <!--
+    #############################################################################
+    COMMAND LINE ARGUMENTS
+    https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
+    #############################################################################
+    -->
+
+    <!-- Pass some flags to PHPCS:
+         p flag: Show progress of the run.
+         s flag: Show sniff codes in all reports.
+    -->
+    <arg value="ps"/>
+
+    <!-- Strip the filepaths down to the relevant bit. -->
+    <arg name="basepath" value="./"/>
+
+    <!-- Check up to 8 files simultanously. -->
+    <arg name="parallel" value="8"/>
+
+    <!-- Only check the PHP files. JS, and CSS files are checked separately with @wordpress/scripts package. -->
+    <arg name="extensions" value="php"/>
+
+    <!-- Check all files in this directory and the directories below it. -->
+    <file>.</file>
+
+    <!-- Exclude patterns. -->
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/.wordpress-org/*</exclude-pattern>
+    <exclude-pattern>*/node_modules/*</exclude-pattern>
+    <exclude-pattern>*/languages/*</exclude-pattern>
+    <exclude-pattern>*/dist/*</exclude-pattern>
+    <exclude-pattern>*/src/*</exclude-pattern>
+    <exclude-pattern>/index\.php</exclude-pattern>
+
+
+    <!--
+    #############################################################################
+    USE THE WordPress AND THE Theme Review RULESET
+    #############################################################################
+    -->
+
+     <!-- Include the WordPress ruleset, with select exclusions. -->
+    <rule ref="WordPress">
+        <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
+        <exclude name="WordPress.VIP.DirectDatabaseQuery.NoCaching" />
+        <exclude name="WordPress.VIP.DirectDatabaseQuery.DirectQuery" />
+        <exclude name="WordPress.VIP.DirectDatabaseQuery.SchemaChange" />
+        <exclude name="WordPress.VIP.FileSystemWritesDisallow.file_ops_fwrite" />
+        <exclude name="WordPress.VIP.RestrictedVariables.user_meta__wpdb__usermeta" />
+        <exclude name="WordPress.VIP.PostsPerPage.posts_per_page_posts_per_page" />
+        <exclude name="WordPress.VIP.RestrictedVariables.cache_constraints___COOKIE" />
+    </rule>
+
+    <!-- Let's also check that everything is properly documented. -->
+    <rule ref="WordPress-Docs"/>
+
+    <!--
+    #############################################################################
+    SNIFF SPECIFIC CONFIGURATION
+    #############################################################################
+    -->
+
+    <!-- Verify that the text_domain is set to the desired text-domain.
+         Multiple valid text domains can be provided as a comma-delimited list. -->
+    <rule ref="WordPress.WP.I18n">
+        <properties>
+            <property name="text_domain" type="array" value="social-network-widget"/>
+        </properties>
+    </rule>
+
+    <!-- Set the minimum supported WP version. This is used by several sniffs.
+         The minimum version set here should be in line with the minimum WP version
+         as set in the "Requires at least" tag in the readme.txt file. -->
+    <config name="minimum_supported_wp_version" value="5.0" />
+
+    <rule ref="WordPress.Arrays.MultipleStatementAlignment">
+        <properties>
+            <!-- No need to adjust alignment of large arrays when the item with the largest key is removed. -->
+            <property name="exact" value="false"/>
+            <!-- Don't align multi-line items if ALL items in the array are multi-line. -->
+            <property name="alignMultilineItems" value="!=100"/>
+            <!-- Array assignment operator should always be on the same line as the array key. -->
+            <property name="ignoreNewlines" value="false"/>
+        </properties>
+    </rule>
+
+    <!-- Verify that everything in the global namespace is prefixed with a theme specific prefix.
+         Multiple valid prefixes can be provided as a comma-delimited list. -->
+    <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
+        <properties>
+            <property name="prefixes" type="array">
+                <element value="social_network_widget"/>
+                <element value="SOCIAL_NETWORK_WIDGET"/>
+                <element value="Social_Network_Widget"/>
+            </property>
+        </properties>
+    </rule>
+
+
+    <!--
+    #############################################################################
+    USE THE PHPCompatibility RULESET
+    #############################################################################
+    -->
+
+    <config name="testVersion" value="7.2-" />
+    <!-- Include sniffs for PHP cross-version compatibility. -->
+    <rule ref="PHPCompatibilityWP"/>
+
+</ruleset>