Part of #2571965: [meta] Fix PHP coding standards in core.
Approach
We are testing coding standards with PHP CodeSniffer, using the Drupal coding standards from the Coder module. Both of these packages are not installed in Drupal core. We need to do a couple of steps in order to download and configure them so we can run a coding standards check.
Step 1: Add the coding standard to the whitelist
Every coding standard is identified by a "sniff". For example, an imaginary coding standard that would require all llamas to be placed inside a square bracket fence would be called the "Drupal.AnimalControlStructure.BracketedFence
sniff". There are dozens of such coding standards, and to make the work easier we have started by only whitelisting the sniffs that pass. For the moment all coding standards that are not yet fixed are simply skipped during the test.
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 PHP CodeSniffer and the ruleset from the Coder module
Both of these packages are not installed by default in Drupal core, so we need to download them. This can be done with Composer, from the root folder of your Drupal installation:
$ composer require drupal/coder squizlabs/php_codesniffer
$ ./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 |
---|---|---|---|
#21 | fix-2572791-20.patch | 437.2 KB | andriyun |
Comments
Comment #2
DuaelFrAs agreed between the mentors at Drupalcon, according to issues to avoid for novices, I am untagging this issue as "Beginner". This issue contains changes across a very wide range of files and might create too many other patches to need to be rerolled at this particular time. This patch has an automated way to be rerolled later so better to implement it after Drupalcon.
Comment #3
pfrenssenComment #5
Mile23Updated issue summary to reflect how things actually work now.
Comment #6
Mile23This patch is the result of fixing errors with phpcbf.
I'm not sure I agree with the sniffer on some of these... For instance anonymous functions look funky when you remove the initial whitespace after the brace, as in:
Comment #7
Mile23Comment #8
klausiYes, you shouldn't run the fixer on one single rule in this case. Other Drupal fixer rules would kick the closure contents to the next line, then it looks more sane.
Comment #9
Mile23Yes, I understand about them being 'uneven.' :-) The matching change would happen in #2572787: Fix 'Drupal.WhiteSpace.CloseBracketSpacing' coding standard
Just that I like the whitespace in the anonymous function. Or perhaps we should have a standard about putting a new line after it and indenting. A bit out of scope for this issue, though.
Comment #10
Mile23Hmm. Maybe not. This looks more wrong than the anonymous function.
Comment #11
alexpottThis sniff needs work or we need to add other sniffs that don't remove sensible spaces from anonymous functions.
Comment #12
andypostComment #13
pfrenssenComment #16
RoSk0Fixed sniff in 8.4.x.
Comment #17
klausiAs me and alexpott said: this fix is wrong. Either we need to include other sniffs here that push this in a correct way to the next line or we need to exclude this file from being checked with PHPCS. Same for the other anonymous function changes in this patch.
Comment #19
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedComment #20
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commented@klausi, @alexpott why only for anonymous function?
I think there are two cases like you pointed:
anonymous inline function
other inline functions
Comment #21
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedNew rerolled patch.
The patch includes fixes for inline function issues.
I've moved return statement to the new line.
Additionaly there are fixes of existing cases with anonymous function like
function() {return $value;}
from core
Comment #22
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedComment #23
mfernea CreditAttribution: mfernea at AmeXio commentedLooks good to me.
No cs issues.
Changes only relate to the targeted sniff.
git diff --staged --color-words
doesn't show code modifications except phpcs.xml.dist.Comment #24
catchCommitted/pushed to 8.5.x and cherry-picked to 8.4.x. Thanks!
Comment #26
catch