Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PSR12 short keyword sniff. #491

Closed
wants to merge 3 commits into from

Conversation

rneufeldcisco
Copy link

The currently available sniffs seem to recommend replacing+

  • @param bool with @param boolean
  • @param int with @param integer

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [] [Required for new sniffs] I have added XML documentation for the sniff.

@jrfnl
Copy link
Member

jrfnl commented May 15, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Util\Common::$allowedTypes and ::suggestTypes() prefer non-normative types
2 participants