Contrib.social

Fix 'Drupal.Commenting.InlineComment.SpacingAfter' coding standard

Open on Drupal.org →
Created on 22 September 2015, over 9 years ago
Updated 17 November 2023, about 1 year ago

Postponing on #2464123: Remove the requirement that no blank line follow an inline comment → .

Part of 🌱 [meta] Fix PHP coding standards in core Active .

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.Commenting.InlineComment.SpacingAfter"/>

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.

📌 Task
Status

Postponed

Version

11.0 🔥

Component
Other  →

Last updated about 9 hours ago

Created by

🇧🇪Belgium attiks

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment almost 2 years ago →
    🇮🇳India nikhil_110
  • Status changed to Needs work almost 2 years ago
  • Comment almost 2 years ago →
    🇺🇸United States smustgrave

    #102 appears to be missing a number of changes from #97 can it be documented why?

    Also the interdiff is the same size of the patch?

  • Comment almost 2 years ago →
    🇳🇿New Zealand quietone

    Thanks for the interest in this work. However, as pointed out in several comments the work here is to address comments #92, #93, #94. And #93 suggests that we don't implement this sniff at all!

    I am changing the status to active so emphasize that the work here is to resolve #92, #93, #94. Also, updating credit per How is credit granted for Drupal core issues → .

  • Status changed to Active almost 2 years ago
  • Comment almost 2 years ago →
    🇳🇿New Zealand quietone
  • Comment about 1 year ago →
    🇷🇺Russia zniki.ru

    I checked #94 and I totally agree that we need to update code sniff rule Drupal.Commenting.InlineComment.SpacingAfter to work with examples provided in #79.
    Do we have issue for that?

    Do I understand it right, before we have agreement or code sniff rule will be update, no further patches should be attached to this issue?

  • Status changed to Postponed about 1 year ago
  • Comment about 1 year ago →
    🇳🇿New Zealand quietone

    @zniki.ru, thanks for the interest in coding standard issues! For some background, there is a Coding Standards project → where the community discusses changes to the Drupal Coding standards. Changes agreed to there usually require a change to the Coder project to implement a new sniff or create a new one. Once, that is done, then we have issues it the core queue to implement the change. There is also the #coding_standards channel in Drupal Slack where coding standards are also discussed.

    There is an issue in the Coding Standards project discussing changing this standard, #2464123: Remove the requirement that no blank line follow an inline comment → . That issue is being worked on so maybe we should postpone this on that issue. I do want to avoid double work. I am adding that as a relating issue and postponing this on that issue.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024