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.
Comment | File | Size | Author |
---|---|---|---|
#4 | drupal-coding-standards-2902728-4.patch | 19 KB | mfernea |
Comments
Comment #2
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the patch.
Comment #3
mfernea CreditAttribution: mfernea at AmeXio commentedStatus change.
Comment #4
mfernea CreditAttribution: mfernea at AmeXio commentedI updated the patch.
Comment #5
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedLooks good to me.
+1 RTBC
Comment #6
mfernea CreditAttribution: mfernea at AmeXio commentedLet's update the status if you think the patch is good. Do you want someone else to review it too?
Comment #7
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedComment #8
xjmGreat work @mfernea. Loving to see these standards get cleaned up.
It looks like there are more violations in
language.module
:When reviewing/RTBCing let's be sure to run the check on all of core to ensure all instances are fixed and no new ones have been introduced.
As a coding standards cleanup, this is eligible for backport during RC, to keep the branches in sync.
Comment #9
mfernea CreditAttribution: mfernea at AmeXio commentedThanks @xjm! I tested the patch with both 8.4 and 8.5 branches and no cs issues are present (of course testing with the full phpcs.xml.dist).
Also, the testbots don't report any cs issues.
So, I'm a bit confused on how those errors could have been thrown.
Looking at the latest from both 8.5.x and 8.4.x, the lines 51 and 54 are fixed by the patch.
Comment #10
jofitz CreditAttribution: jofitz at ComputerMinds commentedI have run through the tests and do not get any errors, including those in #8 (unless I remove the corrections to those lines). Setting back to RTBC.
Comment #12
xjmHuh. I tried again and was able to commit it this time. I did do a composer install which I haven't done for awhile on my maintainer repo so maybe I had an older version of composer there. Anyway all good now. Thanks everyone!
I backported this during RC as a coding standards change, to keep the two branches in sync.
Comment #13
mfernea CreditAttribution: mfernea at AmeXio commentedIs this committed on 8.4.x too? I don't see the commit on that branch.
Comment #15
xjmIt was and I failed to push it earlier. Good catch!