FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

6.x: Add stricter naming convention sniffs by dereuromark · Pull Request #424 · cakephp/cakephp-codesniffer · GitHub

/ cakephp-codesniffer Public

6.x: Add stricter naming convention sniffs - #424

Draft
dereuromark wants to merge 8 commits into
5.xfrom
6.x
ConversationCommits (8)ChecksFiles changed
Draft

6.x: Add stricter naming convention sniffs#424
dereuromark wants to merge 8 commits into
5.xfrom
6.x

Conversation

dereuromark commented Feb 6, 2026

Copy link
Copy Markdown
Member

Summary

This PR introduces stricter naming convention enforcement for CakePHP 6.x, aligned with PSR naming conventions.

New Sniffs

ValidPropertyNameSniff (new)

  • Flags underscore-prefixed properties ($_propertyName)
  • Applies to all visibility levels (public, protected, private)

ValidFunctionNameSniff (updated)

  • Now flags underscore-prefixed protected/private methods
  • Exception: Entity accessor/mutator patterns are still allowed (_getFieldName(), _setFieldName())
  • Added T_ENUM support
  • Fixed $_magicMethods property naming (was using underscore prefix itself)

Ruleset Changes

  • Removed PSR2.Classes.PropertyDeclaration.Underscore exclusion - PSR2 property underscore checks now apply
  • Added new Slevomat sniffs for modern PHP:
    • RequireNullCoalesceEqualOperator - Require ??= operator
    • RequireNullSafeObjectOperator - Require ?-> operator
    • RequireSelfReference - Require self:: instead of class name
    • NullTypeHintOnLastPosition - Enforce string|null instead of null|string

Migration

Projects upgrading to CakePHP 6.x should:

  1. Rename underscore-prefixed properties: $_propertyName → $propertyName
  2. Rename underscore-prefixed methods (except Entity accessors): _methodName() → methodName()

The cakephp/upgrade tool has Rector rules to automate these renames.

Tests

All existing tests pass, new test cases added for:

  • Property underscore detection (class and trait)
  • Method underscore detection with Entity accessor exception

Add stricter naming convention sniffs for CakePHP 6.x
be92b75 
- Update ValidFunctionNameSniff to flag underscore-prefixed protected/private
  methods (except Entity accessor/mutator pattern _get*, _set*)
- Add ValidPropertyNameSniff to flag underscore-prefixed properties
- Remove PSR2.Classes.PropertyDeclaration.Underscore exclusion from ruleset
- Add new Slevomat sniffs:
  - RequireNullCoalesceEqualOperator
  - RequireNullSafeObjectOperator
  - RequireSelfReference
  - NullTypeHintOnLastPosition
- Fix $_magicMethods property naming in sniff itself
- Add T_ENUM support to ValidFunctionNameSniff

dereuromark commented Feb 6, 2026

Copy link
Copy Markdown
Member Author

You're right - removed the custom ValidPropertyNameSniff. The PSR2 built-in handles properties.

Kept the custom ValidFunctionNameSniff though, since it allows the Entity accessor/mutator pattern (_getName, _setField) which the PSR2 method sniff would flag.

dereuromark commented Mar 14, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author

The base is off, should target 6.x right?
So this would not be merged. Only close PR as done.

LordSimal and others added 3 commits March 14, 2026 11:43
add custom enum sniff (#425)
9cf1618
Allow enum suffix omission when in Enum namespace (#428)
1950643 
Relax the ValidEnumNameSniff to allow omitting the "Enum" suffix when
the enum is in a namespace containing "Enum" as a segment (e.g.,
`App\Model\Enum\Status` is now valid without the suffix).

This avoids redundant naming like `App\Model\Enum\FooBarEnum`.

Refs #425
Merge pull request #427 from cakephp/fix-void-null-type-order-conflict
a747422 
Fix conflict between TypeHintSniff and Slevomat null position sniffs
dereuromark mentioned this pull request Mar 14, 2026
Closed
dereuromark marked this pull request as ready for review April 2, 2026 13:08
dereuromark marked this pull request as draft April 2, 2026 13:08
dereuromark and others added 2 commits April 11, 2026 12:32
Disallow partial uses in ReferenceUsedNamesOnly (#431)
c8f3c35 
Partial namespace references like Mockery\MockInterface were not being
flagged by ReferenceUsedNamesOnly because Slevomat's allowPartialUses
defaults to true. Set it to false so such references are required to be
imported via a use statement.
Merge branch '5.x' into 6.x
73da568
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ADmad ADmad left review comments
LordSimal LordSimal approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL