Changeset 43348

Timestamp:

06/15/2018 03:56:58 PM (6 years ago)

Author:

jrf

Message:

Build/Tools: Update PHPCS ruleset for WP Core and related Composer setup.

.gitignore + svn:ignore:

• Add the typical filenames of overloaded PHPCS configs to .gitignore.

Composer:

• Use the develop (Packagist dev-master) version of WPCS as it contains lots of bugfixes.
• Remove the PHPCS dependency. This is a dependency of WPCS, not of WP Core itself. This will also make sure that the PHPCS version used is always one which is supported by WPCS.
• Refreshed the composer.lock file.

PHPCS ruleset:

• Removed a reference to a sniff which doesn't exist in WPCS yet.
• Use the PHPCS 3.x basepath option to clean up the file paths PHPCS shows in the reports.
• Use the PHPCS 3.x parallel option to enable parallel scanning whenever possible to speed up the scans.
• Whitelist the wp-includes/l10n.php file from issues being reported by the WordPress.WP.I18n sniff.

Fixes #44366.

Location:

trunk

Files:

• . (modified) (1 prop)
• .gitignore (modified) (1 diff)
• composer.json (modified) (1 diff)
• composer.lock (modified) (4 diffs)
• phpcs.xml.dist (modified) (2 diffs)

trunk

@@ -3 +3 @@
 wp-tests-config.php
 .htaccess
-
 # Files and folders related to build/test tools
 phpunit.xml
+phpcs.xml
+.phpcs.xml
 node_modules
 npm-debug.log

@@ -3 +3 @@
 wp-tests-config.php
 .htaccess
-
 # Files and folders related to build/test tools
 phpunit.xml
+phpcs.xml
+.phpcs.xml
 node_modules
 npm-debug.log

trunk/.gitignore

@@ -8 +8 @@
 # Files and folders related to build/test tools
 /phpunit.xml
+/.phpcs.xml
+/phpcs.xml
 /tests/phpunit/data/plugins/wordpress-importer
 /tests/phpunit/data/.trac-ticket-cache*

trunk/composer.json

@@ -12 +12 @@
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",
-        "squizlabs/php_codesniffer": "^3.2.3",
-        "wp-coding-standards/wpcs": "dev-feature/new-multi-line-comment-formatting-sniffs"
+        "wp-coding-standards/wpcs": "dev-master"
     },
     "scripts": {

trunk/composer.lock

@@ -5 +5 @@
         "This file is @generated automatically"
     ],
-    "content-hash": "4b409623b2bc5d8e87b7f45d57a60990",
+    "content-hash": "9c2c871b813e89682ef445611d2f5363",
     "packages": [],
     "packages-dev": [
@@ -78 +78 @@
         {
             "name": "squizlabs/php_codesniffer",
-            "version": "3.2.3",
+            "version": "3.3.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
-                "reference": "4842476c434e375f9d3182ff7b89059583aa8b27"
+                "reference": "d86873af43b4aa9d1f39a3601cc0cfcf02b25266"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/4842476c434e375f9d3182ff7b89059583aa8b27",
-                "reference": "4842476c434e375f9d3182ff7b89059583aa8b27",
+                "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/d86873af43b4aa9d1f39a3601cc0cfcf02b25266",
+                "reference": "d86873af43b4aa9d1f39a3601cc0cfcf02b25266",
                 "shasum": ""
             },
@@ -125 +125 @@
                 "standards"
             ],
-            "time": "2018-02-20T21:35:23+00:00"
+            "time": "2018-06-06T23:58:19+00:00"
         },
         {
             "name": "wp-coding-standards/wpcs",
-            "version": "dev-feature/new-multi-line-comment-formatting-sniffs",
+            "version": "dev-master",
             "source": {
                 "type": "git",
                 "url": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git",
-                "reference": "ce4d719296ebbecd01f57bc3729833e89b39ad99"
+                "reference": "cf6b310caad735816caef7573295f8a534374706"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/WordPress-Coding-Standards/WordPress-Coding-Standards/zipball/ce4d719296ebbecd01f57bc3729833e89b39ad99",
-                "reference": "ce4d719296ebbecd01f57bc3729833e89b39ad99",
+                "url": "https://api.github.com/repos/WordPress-Coding-Standards/WordPress-Coding-Standards/zipball/cf6b310caad735816caef7573295f8a534374706",
+                "reference": "cf6b310caad735816caef7573295f8a534374706",
                 "shasum": ""
             },
@@ -165 +165 @@
                 "wordpress"
             ],
-            "time": "2017-11-30T18:28:51+00:00"
+            "time": "2018-02-16T01:57:48+00:00"
         }
     ],

trunk/phpcs.xml.dist

@@ -5 +5 @@
     <rule ref="WordPress-Core"/>
     <rule ref="WordPress.CodeAnalysis.EmptyStatement"/>
-    <rule ref="WordPress.Commenting.DocblockFormat"/>
 
     <arg name="extensions" value="php"/>
+
+    <!-- Strip the filepaths down to the relevant bit. -->
+    <arg name="basepath" value="./"/>
+
+    <!-- Check up to 20 files simultanously. -->
+    <arg name="parallel" value="20"/>
 
     <!-- Show sniff codes in all reports -->
@@ -70 +75 @@
     </rule>
 
+    <!-- Whitelist the I18n functions file from issues identified by the I18n sniff
+        (such as calling the low-level translate() function). -->
+    <rule ref="WordPress.WP.I18n">
+        <exclude-pattern>/src/wp-includes/l10n\.php</exclude-pattern>
+    </rule>
+
     <rule ref="Generic.Functions.FunctionCallArgumentSpacing">
         <exclude-pattern>/wp-config\.php</exclude-pattern>

@@ -3 +3 @@
 wp-tests-config.php
 .htaccess
-
 # Files and folders related to build/test tools
 phpunit.xml
+phpcs.xml
+.phpcs.xml
 node_modules
 npm-debug.log