PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
805 stars 47 forks source link

Add PSR12 short keyword sniff. #491

Closed rneufeldcisco closed 2 months ago

rneufeldcisco commented 2 months ago

The currently available sniffs seem to recommend replacing+

which are in violation of PSR12.

Description

This PR will add a new sniff (a copy of the squiz sniff) as well as adding a new suggestShortType() method to Util\Common which will call the existing suggestType() method and return a short version for compliance.

Suggested changelog entry

Adds function comment sniff to PSR12 to recommend and fix (comments only) long keyword names to short keyword names.

Related issues/external references

Fixes #406

Types of changes

PR checklist

jrfnl commented 2 months ago

@rneufeldcisco Thank you for your interest in PHPCS and your willingness to contribute.

Unfortunately, I'm going to have to reject this PR. The PSR12 standard has no rules at all about comments or docblocks, so the PHPCS PSR12 standard should not contain any comment/docblock sniffs.

Aside from that, trying to introduce huge chunks of (near) duplicate code is not acceptable.