Part of #2571965: [meta] Fix PHP coding standards in core.

Approach

We are testing coding standards with PHP CodeSniffer, using the Drupal coding standards from the Coder module. Both of these packages are not installed in Drupal core. We need to do a couple of steps in order to download and configure them so we can run a coding standards check.

Step 1: Add the coding standard to the whitelist

Every coding standard is identified by a "sniff". For example, an imaginary coding standard that would require all llamas to be placed inside a square bracket fence would be called the "Drupal.AnimalControlStructure.BracketedFence sniff". There are dozens of such coding standards, and to make the work easier we have started by only whitelisting the sniffs that pass. For the moment all coding standards that are not yet fixed are simply skipped during the test.

Open the file core/phpcs.xml.dist and add a line for the sniff of this ticket. The sniff name is in the issue title. Make sure your patch will include the addition of this line.

Step 2: Install PHP CodeSniffer and the ruleset from the Coder module

Both of these packages are not installed by default in Drupal core, so we need to download them. This can be done with Composer, from the root folder of your Drupal installation:

$ composer require drupal/coder squizlabs/php_codesniffer
$ ./vendor/bin/phpcs --config-set installed_paths ../../drupal/coder/coder_sniffer

Once you have installed the phpcs package, you can list all the sniffs available to you like this:

$ ./vendor/bin/phpcs --standard=Drupal -e

This will give you a big list of sniffs, and the Drupal-based ones should be present.

Step 3: Prepare the phpcs.xml file

To speed up the testing you should make a copy of the file phpcs.xml.dist (in the core/ folder) and save it as phpcs.xml. This is the configuration file for PHP CodeSniffer.

We only want this phpcs.xml file to specify the sniff we're interested in. So we need to remove all the rule items, and add only our own sniff's rule. Rule items look like this:

<rule ref="Drupal.Classes.UnusedUseStatement"/>

Remove all of them, and add only the sniff from this issue title. This will make sure that our tests run quickly, and are not going to contain any output from unrelated sniffs.

Step 4: Run the test

Now you are ready to run the test! From within the core/ folder, run the following command to launch the test:

$ cd core/
$ ../vendor/bin/phpcs -p

This takes a couple of minutes. The -p flag shows the progress, so you have a bunch of nice dots to look at while it is running.

Step 5: Fix the failures

When the test is complete it will present you a list of all the files that contain violations of your sniff, and the line numbers where the violations occur. You could fix all of these manually, but thankfully phpcbf can fix many of them. You can call phpcbf like this:

$ ../vendor/bin/phpcbf

This will fix the errors in place. You can then make a diff of the changes using git. You can also re-run the test with phpcs and determine if that fixed all of them.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

attiks created an issue. See original summary.

DuaelFr’s picture

Issue tags: -Novice

As agreed between the mentors at Drupalcon, according to issues to avoid for novices, I am untagging this issue as "Beginner". This issue contains changes across a very wide range of files and might create too many other patches to need to be rerolled at this particular time. This patch has an automated way to be rerolled later so better to implement it after Drupalcon.

pfrenssen’s picture

Issue summary: View changes
andriyun’s picture

Status: Needs review » Needs work

Patch it outdated
Need reroll

andriyun’s picture

Status: Needs work » Needs review
FileSize
116.89 KB

New patch with removed sniff from phpcs.xml.dist file.

andypost’s picture

Status: Needs review » Postponed
Related issues: +#2610984: Add Archive Tar via Composer, with BC shim
+++ b/core/lib/Drupal/Core/Archiver/ArchiveTar.php
@@ -302,7 +302,7 @@ function_exists('dl') === false ||
-        return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
+        return @dl('php_' . $ext . $suffix) || @dl($ext . $suffix);

this change blocked on #2610984: Add Archive Tar via Composer, with BC shim

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

anoopjohn’s picture

Version: 8.1.x-dev » 8.2.x-dev

Is the sniff now Squiz.Strings.ConcatenationSpacing instead of Drupal.Strings.ConcatenationSpacing? Don't see Drupal.Strings.ConcatenationSpacing in phpcs --standard=Drupal -e

andypost’s picture

Title: Fix 'Drupal.Strings.ConcatenationSpacing' coding standard » Fix 'Squiz.Strings.ConcatenationSpacing' coding standard
Status: Postponed » Needs review
FileSize
121.93 KB

Yep, so here's new patch

alexpott’s picture

Status: Needs review » Needs work
Issue tags: +Needs reroll

This patch needs re-rolling - to reroll just apply changes to phpcs.xml.dist and then re-run phpcbf.

andypost’s picture

Status: Needs work » Needs review
Issue tags: -Needs reroll
FileSize
121.03 KB

There's only one this to fix
197 Squiz.Strings.ConcatenationSpacing.PaddingFound

andypost’s picture

FileSize
2.43 KB
pfrenssen’s picture

Issue summary: View changes
pfrenssen’s picture

Issue summary: View changes
pfrenssen’s picture

Issue summary: View changes
alexpott’s picture

Status: Needs review » Needs work
Issue tags: +Needs reroll

To reroll - add rule to phpcs.xml.dist and run phpcbf to fix everything.

alexpott’s picture

Status: Needs work » Needs review
Issue tags: -Needs reroll
FileSize
120.28 KB

So the rule #11 added to phpcs.xml.dist was not set up properly. The instructions need to be updated for all of these patches. The steps should be:

  1. Update core/phpcs.xml.dist
  2. Run phpcbf or make fixes
  3. Ensure running phpcs -p-s from ./core results in no errors
alexpott’s picture

Version: 8.2.x-dev » 8.1.x-dev

This can occur in 8.1.x.

git diff 8.2.x HEAD -w
diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist
index 43545b7..cca0ee8 100644
--- a/core/phpcs.xml.dist
+++ b/core/phpcs.xml.dist
@@ -86,4 +86,12 @@
   <rule ref="Generic.PHP.UpperCaseConstant"/>
   <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>

+  <!-- Squiz sniffs -->
+  <rule ref="Squiz.Strings.ConcatenationSpacing">
+    <properties>
+      <property name="spacing" value="1"/>
+      <property name="ignoreNewlines" value="true"/>
+    </properties>
+ </rule>
+
 </ruleset>

Doing a diff between a branch with the patch applied - shows exactly what we expect.

alexpott’s picture

diff --git a/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php b/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php
index c389191..104f7de 100644
--- a/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php
+++ b/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php
@@ -31,15 +31,24 @@ public function validate($items, Constraint $constraint) {
     }
     if (preg_match('/[^\x{80}-\x{F7} a-z0-9@_.\'-]/i', $name)
       || preg_match(
-        '/[\x{80}-\x{A0}' .       // Non-printable ISO-8859-1 + NBSP
-        '\x{AD}' .                // Soft-hyphen
-        '\x{2000}-\x{200F}' .     // Various space characters
-        '\x{2028}-\x{202F}' .     // Bidirectional text overrides
-        '\x{205F}-\x{206F}' .     // Various text hinting characters
-        '\x{FEFF}' .              // Byte order mark
-        '\x{FF01}-\x{FF60}' .     // Full-width latin
-        '\x{FFF9}-\x{FFFD}' .     // Replacement characters
-        '\x{0}-\x{1F}]/u', // NULL byte and control characters
+        // Non-printable ISO-8859-1 + NBSP
+        '/[\x{80}-\x{A0}' .
+        // Soft-hyphen
+        '\x{AD}' .
+        // Various space characters
+        '\x{2000}-\x{200F}' .
+        // Bidirectional text overrides
+        '\x{2028}-\x{202F}' .
+        // Various text hinting characters
+        '\x{205F}-\x{206F}' .
+        // Byte order mark
+        '\x{FEFF}' .
+        // Full-width latin
+        '\x{FF01}-\x{FF60}' .
+        // Replacement characters
+        '\x{FFF9}-\x{FFFD}' .
+        // NULL byte and control characters
+        '\x{0}-\x{1F}]/u',
         $name)
     ) {
       $this->context->addViolation($constraint->illegalMessage);
diff --git a/core/phpcs.xml.dist b/core/phpcs.xml.dist
index 98c7283..6a979e2 100644
--- a/core/phpcs.xml.dist
+++ b/core/phpcs.xml.dist
@@ -105,4 +105,12 @@
   <rule ref="Generic.PHP.UpperCaseConstant"/>
   <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
 
+  <!-- Squiz sniffs -->
+  <rule ref="Squiz.Strings.ConcatenationSpacing">
+    <properties>
+      <property name="spacing" value="1"/>
+      <property name="ignoreNewlines" value="true"/>
+    </properties>
+ </rule>
+
 </ruleset>

Re-rolled - new non whitespace diff...

dawehner’s picture

Status: Needs review » Reviewed & tested by the community

Thank you alex!

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed 9f3b50c and pushed to 8.1.x and 8.2.x. Thanks!

  • alexpott committed d5d0d6c on 8.2.x
    Issue #2572777 by andypost, alexpott, attiks, andriyun: Fix 'Squiz....

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.