WordPress.org

Make WordPress Core

Opened 5 months ago

Closed 5 months ago

Last modified 5 months ago

#43022 closed defect (bug) (wontfix)

PHPCS config refers to non-existent WordPress.Commenting.DocblockFormat rule

Reported by: bpayton Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: Cc:

Description

Our new PHPCS config phpcs.xml.dist refers to a WordPress.Commenting.DocblockFormat rule that does not appear to be present in the master or develop branches of the WordPress-Coding-Standards repo.

The only place I've found the text "DocblockFormat" in that repo is the feature/new-multi-line-comment-formatting-sniffs branch: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/blob/feature/new-multi-line-comment-formatting-sniffs/WordPress/Sniffs/Commenting/DocblockFormatSniff.php

cc @pento

Change History (2)

#1 @netweb
5 months ago

  • Milestone Awaiting Review deleted
  • Resolution set to wontfix
  • Status changed from new to closed
  • Version trunk deleted

Thanks for the ticket and checking out our shiny new PHPCS bits and pieces @bpayton, you are indeed correct. We're working off of that branch you mention.

For now, you can either use that branch of WPCS, something like this in your composer.json file:

{
    "require": {
        "squizlabs/php_codesniffer": "dev-master",
        "wp-coding-standards/wpcs": "dev-feature/new-multi-line-comment-formatting-sniffs",
        "dealerdirect/phpcodesniffer-composer-installer": "*"
    }
}

Or you can comment out the WordPress.Commenting.DocblockFormat sniff in phpcs.xml.diff

The upstream issue WPCS #1120 is what needs finalising before that branch can be merged into master and a v1 release of WPCS is released.

I'm going to close this ticket as wontfix is it's really an upstream issue, feel free to subscribe to that GitHub issue to keep up with updates

#2 @bpayton
5 months ago

Ah, I thought it would be a WP bug with the current config, but that works for me. Thank you for the clarification.

Note: See TracTickets for help on using tickets.