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
15.52 KB

Here is the patch.

Status: Needs review » Needs work

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

mfernea’s picture

Status: Needs work » Needs review
FileSize
15.53 KB

Re-roll.

Status: Needs review » Needs work

The last submitted patch, 4: drupal-coding-standards-2901785-4.patch, failed testing. View results

mfernea’s picture

Status: Needs work » Needs review
FileSize
15.57 KB

Re-roll.

borisson_’s picture

+++ b/core/lib/Drupal/Component/Diff/Engine/DiffEngine.php
@@ -194,7 +194,7 @@ protected function _diag($xoff, $xlim, $yoff, $ylim, $nchunks) {
+      $x1 = $xoff + (int) (($numer + ($xlim - $xoff) * $chunk) / $nchunks);

@@ -231,7 +231,7 @@ protected function _diag($xoff, $xlim, $yoff, $ylim, $nchunks) {
+      $x1 = $xoff + (int) (($numer + ($xlim - $xoff) * $n) / $nchunks);

are we allowed to also fix the $numer typo in this issue (Should be $number)? Or is that a followup we should open?

mfernea’s picture

Hmm... I would open a new issue. It's not a big change, but it doesn't relate to this issue.

borisson_’s picture

Status: Needs review » Reviewed & tested by the community

In that case, this one looks solid.

xjm’s picture

Status: Reviewed & tested by the community » Needs work
  • As expected, git diff --staged --color-words shows nothing except the added rule.
  • Visual scan of the diff looks correct: A space, added once, numerous times.
  • Coder passes with the patch applied.
  • Coder fails if introduce a regression in one of these things.

However, we should remove the changes to the Diff component, which is ignored now and deliberately kept as close to its extremely nonstandard antecedent. Thanks!

mfernea’s picture

Status: Needs work » Needs review
FileSize
14.24 KB
1.03 KB

Here is the patch and interdiff.

andriyun’s picture

Status: Needs review » Reviewed & tested by the community

Look good to me

* changes for Diff component has been removed
* phpcs has no fails after patch applying
* patch contains changes related only to issue sniff
* phpcs.dist.xml changes has been added added

  • xjm committed 2242f4a on 8.5.x
    Issue #2901785 by mfernea, xjm, andriyun: Fix 'Generic.Formatting....

  • xjm committed 0f27ab0 on 8.4.x
    Issue #2901785 by mfernea, xjm, andriyun: Fix 'Generic.Formatting....
xjm’s picture

Version: 8.5.x-dev » 8.4.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.5.x and cherry-picked to 8.4.x as a coding standards cleanup during RC. Thanks!

Status: Fixed » Closed (fixed)

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