Contrib.social

Fix PHPCS problems

Open on Drupal.org →
Created on 11 July 2023, over 1 year ago
Updated 5 September 2023, over 1 year ago

Problem/Motivation

I've enabled the GitLab CI for this module. While the tests are passing, the PHPCS step fails. Currently this is treated as a warning, but I would like to make passing PHPCS a requirement.

I don't have time to work on it this week, but I'll be at DevDays Vienna next week and should have some time in Contrib sessions. However, if someone wants to take it on before then, it would make me very happy.

Steps to reproduce

You can run PHPCS locally, or check under "Source Code -> CD/CD -> Pipelines".

Proposed resolution

I've copied the list of issues below. Some can be fixed with PHPCBF automatically, but the others will need to be checked and fixed manually.

Remaining tasks

  1. Run PHPCBF.
  2. Fix other issues.
  3. Run PHPCS.

User interface changes

None.

API changes

None.

Data model changes

None.

Output of PHPCS from GitLab CI

Running with gitlab-runner 15.11.0 (436955cb)
  on gitlab-prod-runner-gitlab-runner-b9d989749-vlbkn SEJy4TMb, system ID: r_QZpfYJLjld2G
Resolving secrets 00:00
Preparing the "kubernetes" executor 00:00
Using Kubernetes namespace: gitlabci-prod
Using Kubernetes executor with image drupalci/php-8.1-apache:production ...
Using attach strategy to execute scripts...
Preparing environment 00:31
Waiting for pod gitlabci-prod/runner-sejy4tmb-project-59437-concurrent-1t2k4h to be running, status is Pending
Running on runner-sejy4tmb-project-59437-concurrent-1t2k4h via gitlab-prod-runner-gitlab-runner-b9d989749-vlbkn...
Getting source from Git repository 00:01
Fetching changes...
Initialized empty Git repository in /builds/project/scheduled_publish/.git/
Created fresh repository.
Checking out f4cfce19 as detached HEAD (ref is 8.x-3.x)...
Skipping Git submodules setup
Downloading artifacts 00:09
Downloading artifacts for composer-d10 (56868)...
Downloading artifacts from coordinator... ok        host=drupal-gitlab-job-artifacts.s3.us-west-2.amazonaws.com id=56868 responseStatus=200 OK token=64_sppqN
Executing "step_script" stage of the job script 00:01
$ test -f phpcs.xml.dist || curl -OL https://git.drupalcode.org/$_GITLAB_TEMPLATES_REPO/-/raw/$_GITLAB_TEMPLATES_REF/scripts/phpcs.xml.dist
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   497  100   497    0     0   2958      0 --:--:-- --:--:-- --:--:--  2940
$ vendor/bin/phpcs -s $_WEB_ROOT/modules/custom --report-junit=junit.xml --report-full --report-summary --report-source
FILE: ...stom/scheduled_publish/src/Commands/ScheduledPublishCommands.php
----------------------------------------------------------------------
FOUND 6 ERRORS AND 1 WARNING AFFECTING 7 LINES
----------------------------------------------------------------------
  9 | ERROR   | [x] Doc comment short description must end with a
    |         |     full stop
    |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 12 | WARNING | [ ] The class short comment should describe what the
    |         |     class does and not simply repeat the class
    |         |     name (Drupal.Commenting.ClassComment.Short)
 15 | ERROR   | [ ] Missing short description in doc comment
    |         |     (Drupal.Commenting.DocComment.MissingShort)
 23 | ERROR   | [ ] Missing parameter comment
    |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 30 | ERROR   | [ ] Missing short description in doc comment
    |         |     (Drupal.Commenting.DocComment.MissingShort)
 37 | ERROR   | [x] Expected 1 blank line after function; 0 found
    |         |     (Squiz.WhiteSpace.FunctionSpacing.AfterLast)
 38 | ERROR   | [x] The closing brace for the class must have an
    |         |     empty line before it
    |         |     (Drupal.Classes.ClassDeclaration.CloseBraceAfterBody)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ...tom/scheduled_publish/src/Controller/ScheduledPublishListing.php
----------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------
 12 | WARNING | The class short comment should describe what the
    |         | class does and not simply repeat the class name
    |         | (Drupal.Commenting.ClassComment.Short)
----------------------------------------------------------------------
FILE: ...b/modules/custom/scheduled_publish/src/Form/DeleteUpdateForm.php
----------------------------------------------------------------------
FOUND 13 ERRORS AND 1 WARNING AFFECTING 14 LINES
----------------------------------------------------------------------
   3 | ERROR   | [x] Namespaced classes, interfaces and traits should
     |         |     not begin with a file doc comment
     |         |     (Drupal.Commenting.FileComment.NamespaceNoFileDoc)
  14 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  16 | ERROR   | [x] Missing class doc comment
     |         |     (Drupal.Commenting.ClassComment.Missing)
  20 | ERROR   | [ ] Missing @var tag in member variable comment
     |         |     (Drupal.Commenting.VariableComment.MissingVar)
  25 | ERROR   | [ ] Missing @var tag in member variable comment
     |         |     (Drupal.Commenting.VariableComment.MissingVar)
  30 | ERROR   | [ ] Missing @var tag in member variable comment
     |         |     (Drupal.Commenting.VariableComment.MissingVar)
  31 | ERROR   | [ ] Class property $field_delta should use
     |         |     lowerCamel naming without underscores
     |         |     (Drupal.NamingConventions.ValidVariableName.LowerCamelName)
  68 | ERROR   | [ ] The array declaration extends to column 85 (the
     |         |     limit is 80). The array content should be split
     |         |     up over multiple lines
     |         |     (Drupal.Arrays.Array.LongLineDeclaration)
 118 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 120 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 121 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 123 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 130 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
 192 | ERROR   | [x] Expected 1 space after FUNCTION keyword; 0
     |         |     found
     |         |     (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ...web/modules/custom/scheduled_publish/src/Form/EditUpdateForm.php
----------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 10 LINES
----------------------------------------------------------------------
   3 | ERROR   | [x] Namespaced classes, interfaces and traits should
     |         |     not begin with a file doc comment
     |         |     (Drupal.Commenting.FileComment.NamespaceNoFileDoc)
  15 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  18 | ERROR   | [x] Missing class doc comment
     |         |     (Drupal.Commenting.ClassComment.Missing)
  77 | ERROR   | [x] Array indentation error, expected 6 spaces but
     |         |     found 8
     |         |     (Drupal.Arrays.Array.ArrayIndentation)
 125 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 127 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 128 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 130 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 137 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
 199 | ERROR   | [x] Expected 1 space after FUNCTION keyword; 0
     |         |     found
     |         |     (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ...odules/custom/scheduled_publish/src/Form/MultipleUpdatesForm.php
----------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
----------------------------------------------------------------------
   3 | ERROR | [x] Namespaced classes, interfaces and traits should
     |       |     not begin with a file doc comment
     |       |     (Drupal.Commenting.FileComment.NamespaceNoFileDoc)
  14 | ERROR | [x] Use statements should be sorted alphabetically.
     |       |     The first wrong one is
     |       |     Drupal\scheduled_publish\Plugin\Field\FieldType\ScheduledPublish.
     |       |     (SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses.IncorrectlyOrderedUses)
  16 | ERROR | [x] Missing class doc comment
     |       |     (Drupal.Commenting.ClassComment.Missing)
  37 | ERROR | [x] Inline comments must end in full-stops,
     |       |     exclamation marks, question marks, colons, or
     |       |     closing parentheses
     |       |     (Drupal.Commenting.InlineComment.InvalidEndChar)
  38 | ERROR | [ ] The array declaration extends to column 82 (the
     |       |     limit is 80). The array content should be split up
     |       |     over multiple lines
     |       |     (Drupal.Arrays.Array.LongLineDeclaration)
  86 | ERROR | [x] Inline comments must end in full-stops,
     |       |     exclamation marks, question marks, colons, or
     |       |     closing parentheses
     |       |     (Drupal.Commenting.InlineComment.InvalidEndChar)
 129 | ERROR | [x] Inline comments must end in full-stops,
     |       |     exclamation marks, question marks, colons, or
     |       |     closing parentheses
     |       |     (Drupal.Commenting.InlineComment.InvalidEndChar)
 602 | ERROR | [x] Expected 1 space after FUNCTION keyword; 0
     |       |     found
     |       |     (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ...Plugin/Field/FieldFormatter/ScheduledPublishGenericFormatter.php
----------------------------------------------------------------------
FOUND 38 ERRORS AND 2 WARNINGS AFFECTING 36 LINES
----------------------------------------------------------------------
  21 | ERROR   | [ ] Doc comment short description must be on a
     |         |     single line, further text should be a separate
     |         |     paragraph
     |         |     (Drupal.Commenting.DocComment.ShortSingleLine)
  33 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  38 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  46 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  46 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
  47 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  47 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
  48 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  49 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  50 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  50 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
  51 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  51 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
  52 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  53 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  54 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  81 | ERROR   | [x] Expected 1 blank line after function; 2
     |         |     found
     |         |     (Squiz.WhiteSpace.FunctionSpacing.After)
  90 | ERROR   | [x] Array indentation error, expected 6 spaces but
     |         |     found 8
     |         |     (Drupal.Arrays.Array.ArrayIndentation)
  91 | ERROR   | [x] Array indentation error, expected 6 spaces but
     |         |     found 8
     |         |     (Drupal.Arrays.Array.ArrayIndentation)
  92 | ERROR   | [x] Array closing indentation error, expected 4
     |         |     spaces but found 6
     |         |     (Drupal.Arrays.Array.ArrayClosingIndentation)
 100 | ERROR   | [x] Array indentation error, expected 6 spaces but
     |         |     found 8
     |         |     (Drupal.Arrays.Array.ArrayIndentation)
 106 | ERROR   | [x] Array indentation error, expected 6 spaces but
     |         |     found 8
     |         |     (Drupal.Arrays.Array.ArrayIndentation)
 111 | ERROR   | [x] Array closing indentation error, expected 4
     |         |     spaces but found 6
     |         |     (Drupal.Arrays.Array.ArrayClosingIndentation)
 135 | WARNING | [x] The variable name should be defined after the
     |         |     type
     |         |     (Drupal.Commenting.InlineVariableComment.VarInlineOrder)
 139 | WARNING | [ ] Only string literals should be passed to t()
     |         |     where possible
     |         |     (Drupal.Semantics.FunctionT.NotLiteralString)
 161 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
 162 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 176 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
 177 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 178 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 179 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 180 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 182 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 194 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
 195 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 197 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 199 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 212 | ERROR   | [ ] Concatenating translatable strings is not
     |         |     allowed, use placeholders instead and only one
     |         |     string literal
     |         |     (Drupal.Semantics.FunctionT.Concat)
 214 | ERROR   | [x] Expected 1 blank line after function; 0
     |         |     found
     |         |     (Squiz.WhiteSpace.FunctionSpacing.AfterLast)
 215 | ERROR   | [x] The closing brace for the class must have an
     |         |     empty line before it
     |         |     (Drupal.Classes.ClassDeclaration.CloseBraceAfterBody)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 10 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ..._publish/src/Plugin/Field/FieldWidget/ScheduledPublishWidget.php
----------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 442 | ERROR | [ ] The array declaration extends to column 84 (the
     |       |     limit is 80). The array content should be split up
     |       |     over multiple lines
     |       |     (Drupal.Arrays.Array.LongLineDeclaration)
 510 | ERROR | [ ] The array declaration extends to column 86 (the
     |       |     limit is 80). The array content should be split up
     |       |     over multiple lines
     |       |     (Drupal.Arrays.Array.LongLineDeclaration)
 569 | ERROR | [x] Expected 1 space after FUNCTION keyword; 0
     |       |     found
     |       |     (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
FILE: ...es/custom/scheduled_publish/src/Service/ScheduledPublishCron.php
----------------------------------------------------------------------
FOUND 47 ERRORS AND 7 WARNINGS AFFECTING 50 LINES
----------------------------------------------------------------------
   5 | ERROR   | [x] Non-namespaced classes/interfaces/traits should
     |         |     not be referenced with use statements
     |         |     (Drupal.Classes.UseGlobalClass.RedundantUseStatement)
   6 | ERROR   | [x] Non-namespaced classes/interfaces/traits should
     |         |     not be referenced with use statements
     |         |     (Drupal.Classes.UseGlobalClass.RedundantUseStatement)
   7 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  11 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  13 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  15 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  17 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  19 | WARNING | [x] Unused use statement
     |         |     (Drupal.Classes.UnusedUseStatement.UnusedUse)
  23 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
  26 | WARNING | [ ] The class short comment should describe what the
     |         |     class does and not simply repeat the class
     |         |     name (Drupal.Commenting.ClassComment.Short)
  29 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  37 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  38 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
  42 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  43 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
  47 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  48 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
  52 | ERROR   | [ ] Missing short description in doc comment
     |         |     (Drupal.Commenting.DocComment.MissingShort)
  53 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
  74 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  75 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  76 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  77 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  78 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  79 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
  91 | ERROR   | [x] Function comment short description must start
     |         |     with exactly one space
     |         |     (Drupal.Commenting.DocComment.ShortStartSpace)
  91 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 103 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 105 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 105 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
 137 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 139 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 140 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 142 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 149 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
 161 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 163 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 164 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 169 | ERROR   | [x] Data types in @var tags need to be fully
     |         |     namespaced
     |         |     (Drupal.Commenting.DataTypeNamespace.DataTypeNamespace)
 185 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 187 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 189 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
 190 | ERROR   | [x] Separate the @return and @throws sections by a
     |         |     blank line.
     |         |     (Drupal.Commenting.DocComment.TagGroupSpacing)
 200 | ERROR   | [x] Doc comment short description must end with a
     |         |     full stop
     |         |     (Drupal.Commenting.DocComment.ShortFullStop)
 202 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 203 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 204 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 205 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 205 | ERROR   | [ ] Missing parameter type
     |         |     (Drupal.Commenting.FunctionComment.MissingParamType)
 224 | ERROR   | [ ] The array declaration extends to column 119 (the
     |         |     limit is 80). The array content should be split
     |         |     up over multiple lines
     |         |     (Drupal.Arrays.Array.LongLineDeclaration)
 231 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 232 | ERROR   | [ ] Missing parameter comment
     |         |     (Drupal.Commenting.FunctionComment.MissingParamComment)
 234 | ERROR   | [x] Expected "bool" but found "boolean" for function
     |         |     return type
     |         |     (Drupal.Commenting.FunctionComment.InvalidReturn)
 234 | ERROR   | [ ] Description for the @return value is missing
     |         |     (Drupal.Commenting.FunctionComment.MissingReturnComment)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 24 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
Time: 491ms; Memory: 8MB
PHP CODE SNIFFER REPORT SUMMARY
----------------------------------------------------------------------
FILE                                                  ERRORS  WARNINGS
----------------------------------------------------------------------
...publish/src/Commands/ScheduledPublishCommands.php  6       1
...ublish/src/Controller/ScheduledPublishListing.php  0       1
...m/scheduled_publish/src/Form/DeleteUpdateForm.php  13      1
...tom/scheduled_publish/src/Form/EditUpdateForm.php  9       1
...cheduled_publish/src/Form/MultipleUpdatesForm.php  8       0
...eldFormatter/ScheduledPublishGenericFormatter.php  38      2
...ugin/Field/FieldWidget/ScheduledPublishWidget.php  3       0
...uled_publish/src/Service/ScheduledPublishCron.php  47      7
----------------------------------------------------------------------
A TOTAL OF 124 ERRORS AND 13 WARNINGS WERE FOUND IN 16 FILES
----------------------------------------------------------------------
PHPCBF CAN FIX 58 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
PHP CODE SNIFFER VIOLATION SOURCE SUMMARY
----------------------------------------------------------------------
    SOURCE                                                       COUNT
----------------------------------------------------------------------
[ ] Drupal.Commenting.FunctionComment.MissingParamComment        38
[ ] Drupal.Commenting.DocComment.MissingShort                    12
[x] Drupal.Commenting.DocComment.ShortFullStop                   10
[x] Drupal.Classes.UnusedUseStatement.UnusedUse                  8
[x] Drupal.Commenting.DataTypeNamespace.DataTypeNamespace        8
[ ] Drupal.Commenting.FunctionComment.MissingReturnComment       8
[ ] Drupal.Commenting.FunctionComment.MissingParamType           6
[x] Drupal.Arrays.Array.ArrayIndentation                         5
[ ] Drupal.Arrays.Array.LongLineDeclaration                      5
[x] Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunc  4
[x] Drupal.Commenting.ClassComment.Missing                       3
[ ] Drupal.Commenting.ClassComment.Short                         3
[x] Drupal.Commenting.FileComment.NamespaceNoFileDoc             3
[x] Drupal.Commenting.InlineComment.InvalidEndChar               3
[ ] Drupal.Commenting.VariableComment.MissingVar                 3
[x] Drupal.Arrays.Array.ArrayClosingIndentation                  2
[x] Drupal.Classes.ClassDeclaration.CloseBraceAfterBody          2
[x] Drupal.Classes.UseGlobalClass.RedundantUseStatement          2
[x] Squiz.WhiteSpace.FunctionSpacing.AfterLast                   2
[ ] Drupal.Commenting.DocComment.ShortSingleLine                 1
[x] Drupal.Commenting.DocComment.ShortStartSpace                 1
[x] Drupal.Commenting.DocComment.TagGroupSpacing                 1
[x] Drupal.Commenting.FunctionComment.InvalidReturn              1
[x] Drupal.Commenting.InlineVariableComment.VarInlineOrder       1
[ ] Drupal.NamingConventions.ValidVariableName.LowerCamelName    1
[ ] Drupal.Semantics.FunctionT.Concat                            1
[ ] Drupal.Semantics.FunctionT.NotLiteralString                  1
[x] SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses.  1
[x] Squiz.WhiteSpace.FunctionSpacing.After                       1
----------------------------------------------------------------------
A TOTAL OF 137 SNIFF VIOLATIONS WERE FOUND IN 29 SOURCES
----------------------------------------------------------------------
PHPCBF CAN FIX THE 18 MARKED SOURCES AUTOMATICALLY (58 VIOLATIONS IN TOTAL)
----------------------------------------------------------------------
Uploading artifacts for failed job 00:03
Uploading artifacts...
junit.xml: found 1 matching artifact files and directories 
Uploading artifacts as "archive" to coordinator... 201 Created  id=56870 responseStatus=201 Created token=64_sppqN
Uploading artifacts...
junit.xml: found 1 matching artifact files and directories 
Uploading artifacts as "junit" to coordinator... 201 Created  id=56870 responseStatus=201 Created token=64_sppqN
Cleaning up project directory and file based variables 00:00
ERROR: Job failed: command terminated with exit code 1
📌 Task
Status

Fixed

Version

3.0

Component

Code

Created by

🇮🇪Ireland lostcarpark

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

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024