cakephp / cakephp/cakephp-codesniffer

Order phpdoc annotations meaningfully

Open
#434 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
232
Forks
85
PR merge metrics
No merged PRs in 30d

Description

Especially when using https://github.com/dereuromark/cakephp-ide-helper with a bunch of generics flags enabled one can get a quite big phpdoc list added to each table classe like so

/**
 * StaffMembers Model
 *
 * @property \Cake\ORM\Association\HasMany<\AlfredStaffMembers\Model\Table\StaffMembersProjectsTable> $StaffMembersProjects
 * @property \Cake\ORM\Association\HasMany<\AlfredStaffMembers\Model\Table\StaffMembersWorkTimesTable> $StaffMembersWorkTimes
 * @property \Cake\ORM\Association\HasMany<\AlfredStaffMembers\Model\Table\StaffMemberCarChargesTable> $StaffMemberCarCharges
 * @property \Cake\ORM\Association\HasMany<\App\Model\Table\TimesheetUploadsTable> $TimesheetUploads
 * @property \Cake\ORM\Association\HasMany<\App\Model\Table\MenuItemsTable> $MenuItems
 * @property \Cake\ORM\Association\HasMany<\AlfredStaffMembers\Model\Table\StaffMemberTimeEntriesTable> $StaffMemberTimeEntries
 * @property \Cake\ORM\Association\HasMany<\AlfredStaffMembers\Model\Table\StaffMemberVpnClientsTable> $StaffMemberVpnClients
 * @property \Cake\ORM\Association\BelongsToMany<\AlfredStaffMembers\Model\Table\SoftwareKeysTable> $SoftwareKeys
 * @property \Cake\ORM\Table&\Cake\ORM\Association\HasMany $SoftwareKeysStaffMembers
 * @property \Cake\ORM\Association\HasMany<\AlfredDashboard\Model\Table\DashboardZonesTable> $DashboardZones
 * @method \AlfredStaffMembers\Model\Entity\StaffMember newEmptyEntity()
 * @method \AlfredStaffMembers\Model\Entity\StaffMember newEntity(array<mixed> $data, array<string, mixed> $options = [])
 * @method array<\AlfredStaffMembers\Model\Entity\StaffMember> newEntities(array<mixed> $data, array<string, mixed> $options = [])
 * @method \AlfredStaffMembers\Model\Entity\StaffMember get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
 * @method \AlfredStaffMembers\Model\Entity\StaffMember findOrCreate(\Cake\ORM\Query\SelectQuery|callable|array $search, ?callable $callback = null, array<string, mixed> $options = [])
 * @method \AlfredStaffMembers\Model\Entity\StaffMember patchEntity(\AlfredStaffMembers\Model\Entity\StaffMember $entity, array<mixed> $data, array<string, mixed> $options = [])
 * @method array<\AlfredStaffMembers\Model\Entity\StaffMember> patchEntities(iterable<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array<mixed> $data, array<string, mixed> $options = [])
 * @method \AlfredStaffMembers\Model\Entity\StaffMember|false save(\AlfredStaffMembers\Model\Entity\StaffMember $entity, array<string, mixed> $options = [])
 * @method \AlfredStaffMembers\Model\Entity\StaffMember saveOrFail(\AlfredStaffMembers\Model\Entity\StaffMember $entity, array<string, mixed> $options = [])
 * @method \Cake\Datasource\ResultSetInterface<\AlfredStaffMembers\Model\Entity\StaffMember>|false saveMany(iterable<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array<string, mixed> $options = [])
 * @method \Cake\Datasource\ResultSetInterface<\AlfredStaffMembers\Model\Entity\StaffMember> saveManyOrFail(iterable<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array<string, mixed> $options = [])
 * @method \Cake\Datasource\ResultSetInterface<\AlfredStaffMembers\Model\Entity\StaffMember>|false deleteMany(iterable<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array<string, mixed> $options = [])
 * @method \Cake\Datasource\ResultSetInterface<\AlfredStaffMembers\Model\Entity\StaffMember> deleteManyOrFail(iterable<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array<string, mixed> $options = [])
 * @mixin \Cake\ORM\Behavior\TimestampBehavior
 * @mixin \App\Model\Behavior\SunlimeEncryptionBehavior
 * @extends \Cake\ORM\Table<array{AuditLog: \AuditStash\Model\Behavior\AuditLogBehavior, SunlimeEncryption: \App\Model\Behavior\SunlimeEncryptionBehavior, Timestamp: \Cake\ORM\Behavior\TimestampBehavior}, \AlfredStaffMembers\Model\Entity\StaffMember>
 * @mixin \AuditStash\Model\Behavior\AuditLogBehavior
 * @method bool delete(\AlfredStaffMembers\Model\Entity\StaffMember $entity, array<string, mixed> $options = [])
 * @method bool deleteOrFail(\AlfredStaffMembers\Model\Entity\StaffMember $entity, array<string, mixed> $options = [])
 * @method \AlfredStaffMembers\Model\Entity\StaffMember|array<\AlfredStaffMembers\Model\Entity\StaffMember> loadInto(\AlfredStaffMembers\Model\Entity\StaffMember|array<\AlfredStaffMembers\Model\Entity\StaffMember> $entities, array $contain)
 */
class StaffMembersTable extends Table
{

and as you can see, the ordering is quite out of whack. This should be the concern of the IDE-Helper but instead should be somehow standardized in our CS rules as currently it doesn't complain.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing CS rule that parses class PHPDoc blocks and its related tests. Determine the project’s expected ordering for @property, @method, @mixin, and @extends annotations, then add coverage for the shown mixed ordering. Done means the rule reports nonstandard ordering and accepts correctly ordered blocks.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.