Problem/Motivation

Part of meta-issue #2571965: [meta] Fix PHP coding standards in core
Drupal core doesn't match Squiz.Functions.MultiLineFunctionDeclaration coding standars.

Following these steps to reproduce the issue:

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.

Proposed resolution

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

mfernea created an issue. See original summary.

mfernea’s picture

mfernea’s picture

Status: Active » Needs review

Status change.

Status: Needs review » Needs work

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

mfernea’s picture

Status: Needs work » Needs review
FileSize
142.96 KB

Re-roll.

mfernea’s picture

Patch update for the new issues.

andriyun’s picture

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

Patch is not applicable
need reroll

mfernea’s picture

Assigned: Unassigned » mfernea
mfernea’s picture

Assigned: mfernea » Unassigned
Status: Needs work » Needs review
Issue tags: -Needs reroll

Re-roll.

mfernea’s picture

gmario’s picture

I'm in DrupalCon in Vienna - i'm working on this

robertoperuzzo’s picture

Issue tags: +Vienna2017

I'm at DrupalCon Vienna and I'm working on it with gmario.

robertoperuzzo’s picture

Status: Needs review » Reviewed & tested by the community

I tested patch #11. Result is ok without errors.

My local env:
MacBook Pro (Retina, Mid 2012)
OSX El Capitain 10.11.6
PHP 7.0.0

gmario’s picture

I have tested the patch #11 in a Linux box, PHP 5.6.18 - and it works.
I have followed the steps in description, before apply the patch:

  • runs the test (../vendor/bin/phpcs -p) shows all files that does not respect CS

after patch is been applied:

  • test (../vendor/bin/phpcs -p) shows no error.
Finn Lewis’s picture

I'm mentoring at Drupalcon Vienna and have been working with gmario and robertoperuzzo to test this patch.
All looking good, adding to the 'spreadsheet of awesomeness' for further review!

mradcliffe’s picture

I was able to apply the patch as well successfully on 8.5.x.

I do not have time to review the actual patch because it is quite long, but that is one remaining step that I haven't seen any one due since the patch in comment #11 was posted.

rachel_norfolk’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs issue summary update

Can we re-format the Issue Summary Template according to the Issue Summary Template Standards, please?

This makes it much easier for the potential Core Committer to understand the issue and assess whether to commit.

Thanks

robertoperuzzo’s picture

Ok rachel_norfolk, I'm going to do that.

robertoperuzzo’s picture

Issue summary: View changes

Updated. Do we need to keep original report by mfernea?

rachel_norfolk’s picture

Issue summary: View changes
rachel_norfolk’s picture

Issue summary: View changes

No, it's fine to replace the IS rather than add to it - a version history is kept.

robertoperuzzo’s picture

Status: Needs work » Reviewed & tested by the community

Ok ,fine.

mfernea’s picture

Thanks for the review! Just a hint: for these types of patches which should only introduce whitespace differences you can also use git diff --color-words like command to review. Doing so, you can easily spot other modifications.

xjm’s picture

Status: Reviewed & tested by the community » Needs review

Thanks @mfernea!

This issue is adding a core/phpcs.local.xml file and I don't believe it should be. Can we check why that was added? It may have been staged accidentally.

Finn Lewis’s picture

We've had some feedback that the patch appears to be adding a core/phpcs.local.xml which was perhaps added by mistake in the patch in #11
gmario is taking a look now.

mfernea’s picture

Status: Needs review » Needs work

Yes, my bad! I'll let @gmario create a new patch and interdiff then.

gmario’s picture

Here the news patch and the interdiff with that in #10.

gmario’s picture

Status: Needs work » Needs review
Finn Lewis’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
9.91 KB

Patch applies cleanly.
OSX 10.10.5
PHP 7.1.7
and no longer creates core/phpcs.local.xml
Running ../vendor/bin/phpcs -p now shows no errors or warnings.
Attaching output of ../vendor/bin/phpcs -p to confirm.
I think this is now RTBC

catch’s picture

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 f659d6c on 8.5.x
    Issue #2901726 by mfernea, gmario, finn.lewis, robertoperuzzo,...

Status: Fixed » Closed (fixed)

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