Gitlab CI - PHPCS - Return comments and Class comments

Created on 8 March 2024, 10 months ago
Updated 22 March 2024, 10 months ago

Problem/Motivation

There's not too much left to fix in PHPCS, but given how long it took to put the long lines one to bed, I'm reluctant to attempt too much in one issue.

There are 5 cases of missing return type comments, and 3 missing class comments, so let's try to get those fixed.

--------------------------------------------------------------------------------
PHP CODE SNIFFER VIOLATION SOURCE SUMMARY
--------------------------------------------------------------------------------
    SOURCE                                                                 COUNT
--------------------------------------------------------------------------------
[ ] Drupal.Commenting.FunctionComment.MissingReturnComment                 5
[x] SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses.Incorrectl  5
[x] Drupal.Commenting.ClassComment.Missing                                 3
[ ] Drupal.Semantics.FunctionT.NotLiteralString                            3
[ ] Drupal.Commenting.FunctionComment.MissingParamType                     1
[ ] Drupal.NamingConventions.ValidFunctionName.InvalidPrefix               1
[ ] Generic.CodeAnalysis.UselessOverridingMethod.Found                     1
[ ] Squiz.Arrays.ArrayDeclaration.NoKeySpecified                           1
--------------------------------------------------------------------------------
A TOTAL OF 20 SNIFF VIOLATIONS WERE FOUND IN 8 SOURCES
--------------------------------------------------------------------------------

Steps to reproduce

Review PHPCS output from current GitLab CI pipeline.

Proposed resolution

Add the missing comments.

📌 Task
Status

Fixed

Version

1.0

Component

Code

Created by

🇮🇪Ireland lostcarpark

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024