Changeset 56666

Timestamp:

09/23/2023 10:56:24 AM (13 months ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Improve organization of the PHPCompatibility ruleset.

This commit:

• Adds section headers to the ruleset file.
• Organizes all directives in their respective sections.

No functional changes.

Props jrf.
See #58831.

File:

• trunk/phpcompat.xml.dist (modified) (5 diffs)

trunk/phpcompat.xml.dist

@@ -3 +3 @@
     <description>Apply PHP compatibility checks to all WordPress Core files</description>
 
-    <rule ref="PHPCompatibilityWP"/>
-
-    <!-- WordPress Core currently supports PHP 7.0+. -->
-    <config name="testVersion" value="7.0-"/>
+    <!--
+    #############################################################################
+    COMMAND LINE ARGUMENTS
+    https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
+    #############################################################################
+    -->
 
     <!-- Only scan PHP files. -->
@@ -29 +31 @@
     <arg value="ps"/>
 
+    <!--
+    #############################################################################
+    FILE SELECTION
+    Set which files will be subject to the scans executed using this ruleset.
+    #############################################################################
+    -->
+
     <!-- For now, only the files in src are scanned. -->
     <file>./src/</file>
@@ -41 +50 @@
     <exclude-pattern>/vendor/*</exclude-pattern>
 
-    <!-- Must-Use plugins. -->
+    <!-- Exclude Must-Use plugins. -->
     <exclude-pattern>/src/wp-content/mu-plugins/*</exclude-pattern>
 
-    <!-- Plugins. -->
+    <!-- Exclude plugins. -->
     <exclude-pattern>/src/wp-content/plugins/*</exclude-pattern>
 
-    <!-- Themes except the twenty* themes. -->
+    <!-- Exclude themes except the twenty* themes. -->
     <exclude-pattern>/src/wp-content/themes/(?!twenty)*</exclude-pattern>
 
@@ -55 +64 @@
     -->
     <exclude-pattern>src/wp-includes/sodium_compat/lib/php72compat_const\.php$</exclude-pattern>
+
+    <!--
+    #############################################################################
+    SET UP THE RULESET
+    #############################################################################
+    -->
+
+    <rule ref="PHPCompatibilityWP"/>
+
+    <!-- WordPress Core currently supports PHP 7.0+. -->
+    <config name="testVersion" value="7.0-"/>
+
+    <!--
+    #############################################################################
+    SELECTIVE EXCLUSIONS
+    Exclude specific files for specific sniffs and/or exclude sub-groups in sniffs.
+    #############################################################################
+    -->
 
     <rule ref="PHPCompatibility.FunctionUse.NewFunctions.sodium_crypto_sign_keypair_from_secretkey_and_publickeyFound">
@@ -82 +109 @@
         <exclude-pattern>/random_compat/random_bytes_mcrypt\.php$</exclude-pattern>
     </rule>
+
 </ruleset>