Changeset 13850

Timestamp:

05/04/2024 12:56:31 PM (11 months ago)

Author:

espellcaste

Message:

Improve handing of PHP code standards using WPCS

Until we have all WPCS warnings and errors fixed, we block pull requests, and releases, with code with escaping or/and PHP Compatibility issues.

For local development only, we set WPCS severity to 1 to see everything that is not effectively turned off.

Run composer run phpcs for showing all WPCS issues.
Run composer run phpcs-escape for showing escaping issues.
Run composer run phpcompat for showing PHP Compatibility issues.

See #7228
Closes ​https://github.com/buddypress/buddypress/pull/282/

Location:

trunk

Files:

• .github/workflows/coding-standards.yml (modified) (1 diff)
• Gruntfile.js (modified) (3 diffs)
• composer.json (modified) (1 diff)
• phpcs.xml.dist (modified) (2 diffs)

trunk/.github/workflows/coding-standards.yml

@@ -34 +34 @@
           composer-options: "--ignore-platform-reqs"
 
-      - name: Run PHPCS
-        run: composer phpcs
+      - name: Run PHPCS Escape
+        run: composer phpcs-escape
+
+      - name: Run PHP Compatibility
+        run: composer phpcompat

trunk/Gruntfile.js

@@ -161 +161 @@
             }
         },
+        // Remove this when all WPCS issues are resolved.
         checktextdomain: {
             options: {
@@ -343 +344 @@
                 stdout: false
             },
+            phpcs_escape: {
+                command: 'composer run phpcs-escape',
+                stdout: true
+            },
             phpcompat: {
-                command: './vendor/bin/phpcs -p --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 5.6- src tests',
+                command: 'composer run phpcompat',
                 stdout: true
             },
@@ -402 +407 @@
     grunt.registerTask( 'style', ['stylelint', 'sass', 'postcss', 'rtlcss'] );
     grunt.registerTask( 'makepot', ['exec:makepot'] );
-    grunt.registerTask( 'commit', ['src', 'checktextdomain', 'imagemin', 'phplint', 'exec:phpcompat'] );
+    grunt.registerTask( 'commit', ['src', 'checktextdomain', 'imagemin', 'phplint', 'exec:phpcs_escape', 'exec:phpcompat'] );
     grunt.registerTask( 'commit:blocks', ['commit', 'exec:blocks_src', 'exec:modernJS_src'] );
     grunt.registerTask( 'bp_rest', [ 'exec:rest_api', 'copy:bp_rest_components', 'copy:bp_rest_core', 'clean:bp_rest' ] );

trunk/composer.json

@@ -49 +49 @@
         "phpcs": "@php ./vendor/bin/phpcs . --basepath=.",
         "phpcbf": "@php ./vendor/bin/phpcbf . --basepath=.",
+        "phpcs-escape": "@php ./vendor/bin/phpcs src --extensions=php -sp --standard=BuddyPress --sniffs=WordPress.Security.EscapeOutput",
+        "phpcompat": "@php ./vendor/bin/phpcs --standard=PHPCompatibilityWP --extensions=php -sp --runtime-set testVersion 5.6- src tests",
         "test:watch": [
             "Composer\\Config::disableProcessTimeout",

trunk/phpcs.xml.dist

@@ -12 +12 @@
     v flag: Print processed files.
     -->
-    <arg value="psv" />
+    <arg value="sp" />
+
+    <!-- Make it pretty. -->
+    <arg name="colors"/>
 
     <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
@@ -20 +23 @@
     <arg name="parallel" value="20"/>
 
-    <!-- Set severity to 6 to see everything that isn't effectively turned off. -->
-    <arg name="severity" value="6"/>
+    <!-- Set severity to 1 to see everything that isn't effectively turned off. -->
+    <arg name="severity" value="1"/>
 
     <!-- What to exclude -->