Upgrade to WordPressCS 3.0.0

[jrfnl]

CS: align equal signs for consecutive statements (pre-existing)

Composer: update CS dependencies

WordPressCS 3.0.0 has been released.

This commit updates the Composer dependencies to use the new version, including updating the underlying PHP_CodeSniffer dependency to the new minimum supported version for WPCS.

Note: the Composer PHPCS installer plugin is no longer explicitly required as it is now a dependency of WordPressCS, so we inherit the dependency automatically.

PHPCS: improve organisation of the WordPressCS based PHPCS ruleset

No functional changes.

This commit:

• Adds section headers to the ruleset file.
• Organizes all directives in their respective sections.

PHPCS: update the ruleset for WordPressCS 3.0.0

This commit:

• Raises the memory limit to be on the safe side as WPCS 3.0.0 contains a lot more sniffs.
• Removes explicit inclusions of extra rules, which have now been added to the WordPress-Core ruleset..
• Updates property names for select sniffs.
• Updates one exclusion - the WordPress.CodeAnalysis.AssignmentInCondition sniff has been (partially) replaced by the Generic.CodeAnalysis.AssignmentInCondition sniff.
• Adds one new exclusion.

PHPCS: remove the custom property for the FileName sniff

Test files should comply with the naming conventions accepted by PHPUnit, not with the WP naming conventions.

While the WordPress.File.FileName sniff makes a best effort to prevent throwing errors for files containing test classes, the recommended manner to deal with test files is to exclude the complete test directory from being subject to this sniff.

This updates the ruleset to follow the recommendation.

PHPCS: downgrade one new error to a warning

The Generic.Files.OneObjectStructurePerFile sniff enforces that there is only one OO structure declaration per file.

At this time, this sniff would yield 29 errors.

By downgrading the sniff to a warning, the build can pass and we buy ourselves time to fix these 29 issues.

For the time being, the test directory will be excluded until the issues are fixed (as the test directory CS run does not allow for warnings).

CS: update ignore annotations for WPCS 3.0.0

CS: remove redundant ignore annotations [1] / never needed

Remove ignore annotations which are ignoring an error which would not be thrown for that code.

Includes tidying up the format of the ignore annotation:

• Customary one space between the // and the start of the comment.
• There should be no spaces in the comma-separated sniff list.

CS: remove redundant ignore annotations [2] / not needed

Remove ignore annotations which are unnecessary due to the configuration in the phpcs.xml.dist ruleset already taking care of this.

CS: remove redundant ignore annotations [3] / no longer needed

Remove ignore annotations about invalid function names for deprecated functions. Those are ignored by design by WPCS since version 2.2.0.

CS: remove redundant ignore annotations [4] / Unused WPCS rules

Remove ignore annotations related to sniffs which are not used by WP Core (like sniffs which are in the WordPress-Extra ruleset).

CS: remove redundant ignore annotations [5] / Non-WPCS rules

The VariableAnalysis standard is not used by WP Core.

CS: use pre-[in|de]crement instead of post-[in|de]crement for stand-alone statements

CS: remove superfluous blank line(s) at end of file

CS: remove redundant blank line(s) at end of classes

CS: remove redundant blank line(s) at end of functions

CS: fix spacing for spread operators

No space allowed between the operator and the variable it applies to.

Modernize: use dirname() with the $levels parameter

PHP 7.0 introduced the $levels parameter to the dirname() function, which means nested calls to dirname() are no longer needed.

Ref: https://www.php.net/manual/en/function.dirname.php

CS: one space after function keyword for closures

CS: remove redundant semi-colons

As these are not closures/anonymous classes, these semi-colons are redundant and create an empty PHP statement.

🆕 QA: don't use reserved keyword as parameter in newly introduced function

Introduced via Trac 41125.

GH Actions: tweak coding standards workflow

The PHPCS run can now be run on the latest PHP version as all known PHP 8.x compatibility issues (in WPCS) have been fixed.

Trac ticket: https://core.trac.wordpress.org/ticket/59161

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[jrfnl]

FYI: I've recreated the PR to get it out of conflict state and to get rid of newly introduced issues. Includes one new commit (annotated in the PR description).

Would be lovely if we could get some movement on this PR to prevent having to keep recreating the PR.....

[jrfnl]

Rebased the PR to allow for seeing the current status after a number of commits have gone in (thanks @SergeyBiryukov !).

Includes one new commit to address newly introduced issues.

[jrfnl]

Rebased the PR to allow for seeing the current status after a number of commits have gone in (thanks @SergeyBiryukov !).

Includes three (!) new commits to address newly introduced issues.

[dmsnell]

thanks for the update! this line should disappear from the PR on the next rebase, as the code it's modifying is now gone

[jrfnl]

@SergeyBiryukov Looks like some merge artifact crept in with that merge ? Want me to rebase instead ?

[SergeyBiryukov]

Looks like some merge artifact crept in with that merge ?

Yeah, I tried to rebase to see what's left and move those changes to Gutenberg, but something went wrong, and I reverted it.

Want me to rebase instead ?

That would be great 🙂

[jrfnl]

Want me to rebase instead ?

That would be great 🙂

Done!

[jrfnl]

Rebased again just so we can see what's left.

[SergeyBiryukov]

Rebased again just so we can see what's left.

@jrfnl Thanks! I have opened WordPress/gutenberg#55615 to handle the change in wp-includes/blocks/calendar.php.

For the change in wp-includes/class-wp-block-parser-block.php, however, it appears that it cannot be merged as-is upstream, since Gutenberg does not have a corresponding section in phpcs.xml.dist.

I think we can instead remove the section from WP Core's phpcs.xml.dist file, as it does not seem necessary with the affected lines already ignored in the file itself. See 59161.wp-block-parser-block.diff. What do you think?

[SergeyBiryukov]

I think we can instead remove the section from WP Core's phpcs.xml.dist file, as it does not seem necessary with the affected lines already ignored in the file itself. See 59161.wp-block-parser-block.diff.

Done in r57017. That was the last of the changes here, so I believe this PR is now fully addressed.