Part of meta-issue #2572645: [Meta] Fix 'Drupal.Commenting.FunctionComment' coding standard
Step 1: Preparation
Open the file core/phpcs.xml.dist
and add / remove a line for the sniff of this ticket. The sniff name is in the issue title. Make sure your patch will include the addition / removal 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 -ps
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 |
---|---|---|---|
#7 | drupal-coding-standards-2903908-7.patch | 20.12 KB | mfernea |
Comments
Comment #2
mfernea CreditAttribution: mfernea at AmeXio commentedFix title.
Comment #3
mfernea CreditAttribution: mfernea at AmeXio commentedHere is the patch.
Comment #4
martin107 CreditAttribution: martin107 as a volunteer commentedIssues of this type are in reroll hell.
As a patch of this type gets committed it forces a reroll of all other patches under review.
So my plan is shepard one patch at a time until committed.
So I am just making notes here...
for the time when then this issue is selected to be committed - and hopefully this will cut down the number of rerolls we need to do
testbot is reporting problems with EntityOperations and StylePluginBase.
in time this will also need a reroll....
Comment #5
mfernea CreditAttribution: mfernea at AmeXio commentedIn this case it was just a mistake.
I guess the best option would be to mark cs issues as postponed if we see that one depends on the other. The next to be committed should be the simplest one.
Comment #7
mfernea CreditAttribution: mfernea at AmeXio commentedRe-roll.
Comment #8
martin107 CreditAttribution: martin107 as a volunteer commentedI am trying to sit on one of the these issue at a time
- review it with a quick turnaround until committed.
I want to focus on this issue.
...I can't review as it needs reroll. :(
Comment #9
jofitz CreditAttribution: jofitz at ComputerMinds commentedI disagree, this applies cleanly to my up-to-date 8.5.x branch. I even tried creating a new patch, but the interdiff was blank so didn't both uploading.
@martin107 Why do you think it needs a re-roll?
Comment #10
martin107 CreditAttribution: martin107 as a volunteer commentedAh crap sorry, just pulled in updates ... and now the patch applies.... my mistake
So here is the review
After a visual scan, all the changes are expected ...
1) spacing adjustment (ONLY)
2) the required change to core/phpcs.xml.dist
3) The last test report has no last minute coding standard warnings
I think this is done ...
Comment #13
catchCommitted/pushed to 8.5.x and cherry-picked to 8.4.x. Thanks!