Part of meta-issue #2571965: [meta] Fix 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.

Members fund testing for the Drupal project. Drupal Association Learn more

Comments

mfernea created an issue. See original summary.

mfernea’s picture

Status: Active » Needs review
FileSize
1.38 KB

Here is the patch.

ccjjmartin’s picture

Status: Needs review » Reviewed & tested by the community

Code changes look good. I can confirm that this patch applies on the latest 8.5.x branch. That the only error that occurred on the un-patched version was the one that is fixed by this patch. I can also confirm that the patch does address the coding standard desired and the standard being added matches the Drupal Coding Standards from the coder package in ../vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml for "ForLoops" and that the web interface isn't throwing any errors from the code changes.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 2: drupal-coding-standards-2901791-2.patch, failed testing. View results

mfernea’s picture

Status: Needs work » Needs review
FileSize
1.27 KB

Re-roll.

mfernea’s picture

@ccjjmartin: Are you available for a review? :)

ccjjmartin’s picture

@mfernea checking it now

ccjjmartin’s picture

Status: Needs review » Reviewed & tested by the community

RTBC, this still matches the coder xml standards file, still fixes the only error thrown before the patch and nothing is broken in the UI.

mfernea’s picture

Thanks for the prompt review! ;)

  • catch committed 38ac132 on 8.5.x
    Issue #2901791 by mfernea: Fix 'Squiz.ControlStructures....

  • catch committed 8205010 on 8.4.x
    Issue #2901791 by mfernea: Fix 'Squiz.ControlStructures....

catch credited catch.

catch’s picture

Status: Reviewed & tested by the community » Fixed

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

Status: Fixed » Closed (fixed)

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