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

Step 1: Preparation

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 & configure PHPCS

Install PHP CodeSniffer and the ruleset from the Coder module:

$ composer install
$ ./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.

CommentFileSizeAuthor
#2 drupal-coding-standards-2902529-2.patch4.43 KBmfernea
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mfernea created an issue. See original summary.

mfernea’s picture

mfernea CreditAttribution: mfernea at AmeXio commented
Status: Active » Needs review
FileSize
drupal-coding-standards-2902529-2.patch4.43 KB

Here is the patch.

ccjjmartin’s picture

ccjjmartin CreditAttribution: ccjjmartin as a volunteer commented
Status: Needs review » Reviewed & tested by the community

Verified that this failed before the patch with:

FILE: /Users/developer/repos/contrib/drupal8/core/includes/file.inc
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 926 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: ...trib/drupal8/core/lib/Drupal/Component/Datetime/DateTimePlus.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 435 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: ...t/tests/src/Functional/EntityResource/EntityResourceTestBase.php
----------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
  331 | ERROR | More than 2 empty lines are not allowed
  376 | ERROR | More than 2 empty lines are not allowed
 1004 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: ...s/contrib/drupal8/core/modules/simpletest/src/KernelTestBase.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 457 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: ...8/core/modules/views/src/Plugin/views/filter/BooleanOperator.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 52 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: .../core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 1202 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------


FILE: ...drupal8/core/tests/Drupal/Tests/Core/Access/AccessResultTest.php
----------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------
 701 | ERROR | More than 2 empty lines are not allowed
 702 | ERROR | More than 2 empty lines are not allowed
----------------------------------------------------------------------

And after applying the patch I got zero errors. Great job!

  • catch committed c839246 on 8.5.x 
    Issue #2902529 by mfernea: Fix 'Drupal.WhiteSpace.EmptyLines' coding...

catch credited catch.

catch’s picture

catch
he/him
Primary language English
CreditAttribution: catch at Third and Grove commented
Version: 8.5.x-dev » 8.4.x-dev
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 8.5.x and cherry-picked to 8.4.x. Thanks!

  • catch committed e3a340e on 8.4.x 
    Issue #2902529 by mfernea: Fix 'Drupal.WhiteSpace.EmptyLines' coding...
catch’s picture

catch
he/him
Primary language English
CreditAttribution: catch at Third and Grove commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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