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
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 root folder run the following command to launch the test:
$ composer run --timeout 600 phpcs -- -ps --standard=core/phpcs.xml
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:
$ composer run 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 |
---|---|---|---|
#8 | drupal-coding-standards-2923886-8.patch | 2.98 KB | mfernea |
#2 | drupal-coding-standards-2923886-2.patch | 3.36 KB | mfernea |
Comments
Comment #2
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the patch.
Comment #3
malaynayak CreditAttribution: malaynayak as a volunteer and at TA Digital commentedHi,
The patch got applied successfully and fixes the mentioned coding standard errors. Making the issue as rtbc.
Comment #4
catchCommitted 4daa23c and pushed to 8.5.x. Thanks!
Comment #6
xjmLet's create an 8.5.x backport which makes the cleanups but doesn't enable the rules.
Comment #7
mfernea CreditAttribution: mfernea at AmeXio commentedI think you mean "8.4.x backport".
Comment #8
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the patch for 8.4.x.
Comment #9
mfernea CreditAttribution: mfernea at AmeXio commentedComment #10
saravanaprasanth CreditAttribution: saravanaprasanth at DrupalPartners for Innoppl Technologies Pvt. Ltd commentedHi,
The patch for 8.4.x got applied successfully and followed the Drupal coding standards.
Comment #11
saravanaprasanth CreditAttribution: saravanaprasanth at DrupalPartners for Innoppl Technologies Pvt. Ltd commentedComment #12
saravanaprasanth CreditAttribution: saravanaprasanth at DrupalPartners for Innoppl Technologies Pvt. Ltd commentedComment #13
xjmThank you @saravanaprasanth for reviewing this issue and welcome to Drupal.org. :)
The automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. When you do post a review, be sure to describe what you reviewed and how. This helps other reviewers understand why you considered the issue RTBC (and is considered for issue credit).