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
Neither of these packages is 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.Semantics.FunctionAlias"/>
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 -s
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. The -s
flag displays the sniff name in the error report for convenience.
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 some of the errors in place.
You can then make a diff of the changes using git. This will show you what phpcbf
did. It might have done the wrong thing, so you must review the changes.
You must also re-run the test with phpcs
and determine whether all the errors were actually fixed.
If not, go through again and make appropriate changes.
Then upload your patch with the changes to code and your change to core/phpcs.xml.dist
.
Comment | File | Size | Author |
---|---|---|---|
#16 | drupal-coding-standards-2759789-16.patch | 9.16 KB | mfernea |
Comments
Comment #2
Mile23This patch adds the new rule and makes all the changes, except for two.
The rule says to replace dir() with getdir(), which doesn't exist. This error is thrown for core/includes/file.inc and core/lib/Drupal/Core/Composer/Composer.php
Filed this issue on Coder: #2764451: Check validity of Drupal.Semantics.FunctionAlias.FunctionAlias replacements
Comment #3
dawehnerShould we put a coding standards ignore for now or fix coder itself first?
Comment #5
klausiPatch looks good, but I think we should exclude the 2 files in phpcs.xml.dist for this sniff while there is no new release of Coder. Then people can still run phpcs with Coder 8.2.9 without getting errors for those files.
Comment #8
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the patch.
Comment #10
Mile23The patch applies to both 8.5.x and 8.4.x.
Locally gives me no PHPCS errors remaining.
The coder issue is fixed: #2764451: Check validity of Drupal.Semantics.FunctionAlias.FunctionAlias replacements
Drupal 8.5.x is using the fixed version:
Not sure about the failing test, since the patch doesn't touch outside_in. It appears to be a random fail test: #2829040: [meta] Known intermittent, random, and environment-specific test failures #2901626: CSS animations cause \Drupal\Tests\outside_in\FunctionalJavascript\OutsideInBlockFormTest random fails
I'm calling this RTBC despite the fail.
Comment #12
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the updated patch.
Comment #13
mfernea CreditAttribution: mfernea at AmeXio commented@Mile23: Are you available for a review? :)
Comment #14
borisson_Looks solid.
Comment #15
xjmWe've added a rule to ignore the Diff component, so hunks changing it should be removed from the patch. Also, the patch no longer applies.
Thanks!
Comment #16
mfernea CreditAttribution: mfernea at AmeXio commentedUpdated patch excluding modifications to Diff component.
Comment #17
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedLook good to me
* the Diff component changes are no longer present in the patch
* phpcs has no fails after patch applying
* patch contains changes related only to issue sniff
* phpcs.dist.xml changes has been added added
Comment #18
andriyun CreditAttribution: andriyun at Skilld, Drupal Ukraine Community commentedComment #21
xjmThis one made me do a double-take; I forgot that old chestnut about how
implode()
accepts arguments in either order. I guess the coder rule enforces$glue, array $pieces
.Committed and pushed to 8.5.x, and backported to 8.4.x as a coding standards cleanup during RC. Thanks!