Part of meta-issue #2571965: [meta] Fix PHP coding standards in core, stage 1
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 |
|---|---|---|---|
| #11 | drupal-coding-standards-2901785-11.patch | 14.24 KB | mfernea |
Comments
Comment #2
mfernea commentedHere is the patch.
Comment #4
mfernea commentedRe-roll.
Comment #6
mfernea commentedRe-roll.
Comment #7
borisson_are we allowed to also fix the
$numertypo in this issue (Should be$number)? Or is that a followup we should open?Comment #8
mfernea commentedHmm... I would open a new issue. It's not a big change, but it doesn't relate to this issue.
Comment #9
borisson_In that case, this one looks solid.
Comment #10
xjmgit diff --staged --color-wordsshows nothing except the added rule.However, we should remove the changes to the Diff component, which is ignored now and deliberately kept as close to its extremely nonstandard antecedent. Thanks!
Comment #11
mfernea commentedHere is the patch and interdiff.
Comment #12
andriyun commentedLook good to me
* changes for Diff component has been removed
* phpcs has no fails after patch applying
* patch contains changes related only to issue sniff
* phpcs.dist.xml changes has been added added
Comment #15
xjmCommitted and pushed to 8.5.x and cherry-picked to 8.4.x as a coding standards cleanup during RC. Thanks!