The module has several coding standard violations. Let's fix that.

In addition, let's add a drupalci.yml file to check for these problems on each issue.

FILE: stackpath/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
----------------------------------------------------------------------
 5 | WARNING | Line exceeds 80 characters; contains 90 characters
 9 | WARNING | Line exceeds 80 characters; contains 95 characters
----------------------------------------------------------------------


FILE: stackpath/src/Entity/StackPathPurgerSettings.php
-------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
-------------------------------------------------------------------------------------------------
  1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line
  4 | ERROR | [x] There must be one blank line after the namespace declaration
 43 | ERROR | [x] Doc comment short description must end with a full stop
 47 | ERROR | [ ] Class property $stack_id should use lowerCamel naming without underscores
 50 | ERROR | [x] Doc comment short description must end with a full stop
 54 | ERROR | [ ] Class property $client_id should use lowerCamel naming without underscores
 57 | ERROR | [x] Doc comment short description must end with a full stop
 61 | ERROR | [ ] Class property $client_secret should use lowerCamel naming without underscores
-------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------


FILE: stackpath/src/Plugin/Purge/Purger/StackPathPurger.php
------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 1 WARNING AFFECTING 13 LINES
------------------------------------------------------------------------------------
   1 | ERROR   | [x] The PHP open tag must be followed by exactly one blank line
   4 | ERROR   | [x] There must be one blank line after the namespace declaration
  30 | ERROR   | [ ] Missing short description in doc comment
  36 | ERROR   | [x] Doc comment short description must end with a full stop
  71 | ERROR   | [ ] Missing parameter comment
  72 | ERROR   | [ ] Missing parameter comment
  82 | ERROR   | [ ] Doc comment short description must start with a capital letter
  82 | ERROR   | [x] Doc comment short description must end with a full stop
 101 | ERROR   | [ ] Doc comment short description must start with a capital letter
 101 | ERROR   | [x] Doc comment short description must end with a full stop
 204 | ERROR   | [x] Return comment indentation must be 3 spaces, found 4 spaces
 218 | ERROR   | [x] Expected newline after closing brace
 224 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
 244 | ERROR   | [x] Return comment indentation must be 3 spaces, found 4 spaces
 269 | ERROR   | [ ] Doc comment short description must start with a capital letter
 269 | ERROR   | [x] Doc comment short description must end with a full stop
------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 10 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------


FILE: stackpath/src/Plugin/Purge/DiagnosticCheck/ConfigurationCheck.php
--------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------------------
 71 | ERROR | [x] Equals sign not aligned correctly; expected 1 space but found 2 spaces
 84 | ERROR | [x] Expected 1 blank line after function; 0 found
 85 | ERROR | [x] The closing brace for the class must have an empty line before it
--------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------


FILE: stackpath/src/Plugin/Purge/TagsHeader/StackPathTagsHeader.php
----------------------------------------------------------------------------------------
FOUND 9 ERRORS AFFECTING 7 LINES
----------------------------------------------------------------------------------------
  1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line
  4 | ERROR | [x] There must be one blank line after the namespace declaration
 22 | ERROR | [ ] Missing short description in doc comment
 30 | ERROR | [ ] Missing parameter comment
 31 | ERROR | [ ] Missing parameter comment
 31 | ERROR | [ ] Missing parameter type
 32 | ERROR | [ ] Missing parameter comment
 32 | ERROR | [ ] Missing parameter type
 33 | ERROR | [ ] Missing parameter comment
----------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------


FILE: stackpath/src/StackPathApi.php
--------------------------------------------------------------------------------------
FOUND 36 ERRORS AND 2 WARNINGS AFFECTING 32 LINES
--------------------------------------------------------------------------------------
   1 | ERROR   | [x] The PHP open tag must be followed by exactly one blank line
   4 | ERROR   | [x] There must be one blank line after the namespace declaration
  15 | ERROR   | [x] Doc comment short description must end with a full stop
  26 | ERROR   | [ ] Missing short description in doc comment
  31 | ERROR   | [ ] Missing short description in doc comment
  36 | ERROR   | [ ] Missing short description in doc comment
  44 | ERROR   | [ ] Missing parameter comment
  45 | ERROR   | [ ] Missing parameter comment
  57 | ERROR   | [ ] Missing short description in doc comment
  58 | ERROR   | [ ] Missing parameter comment
  58 | ERROR   | [ ] Missing parameter type
  60 | ERROR   | [ ] Description for the @return value is missing
  69 | ERROR   | [ ] Missing parameter comment
  69 | ERROR   | [ ] Missing parameter type
  71 | ERROR   | [ ] Description for the @return value is missing
  78 | WARNING | [ ] Line exceeds 80 characters; contains 88 characters
  80 | WARNING | [ ] Line exceeds 80 characters; contains 94 characters
  94 | ERROR   | [ ] Missing short description in doc comment
  95 | ERROR   | [ ] Missing parameter comment
  95 | ERROR   | [ ] Missing parameter type
  96 | ERROR   | [ ] Missing parameter comment
  96 | ERROR   | [ ] Missing parameter type
  98 | ERROR   | [ ] Description for the @return value is missing
 116 | ERROR   | [x] Expected newline after closing brace
 122 | ERROR   | [ ] Missing short description in doc comment
 123 | ERROR   | [ ] Missing parameter comment
 123 | ERROR   | [ ] Missing parameter type
 125 | ERROR   | [ ] Description for the @return value is missing
 131 | ERROR   | [ ] Missing short description in doc comment
 132 | ERROR   | [ ] Missing parameter comment
 141 | ERROR   | [ ] Missing parameter comment
 141 | ERROR   | [ ] Missing parameter type
 142 | ERROR   | [ ] Missing parameter comment
 143 | ERROR   | [ ] Missing parameter comment
 145 | ERROR   | [ ] Type hint "null" missing for $type
 167 | ERROR   | [x] Case breaking statements must be followed by a single blank line
 175 | ERROR   | [x] Case breaking statements must be followed by a single blank line
 188 | ERROR   | [x] Expected newline after closing brace
--------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------


FILE: stackpath/src/Form/StackPathPurgerConfigForm.php
---------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------
  29 | ERROR | [ ] Missing parameter comment
  56 | ERROR | [ ] Public method name "StackPathPurgerConfigForm::getFormID" is not in lowerCamel format
 129 | ERROR | [x] Expected 1 blank line after function; 0 found
 130 | ERROR | [x] The closing brace for the class must have an empty line before it
---------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------
CommentFileSizeAuthor
#6 stackpath-coding-standards-3079446-6.patch794 bytesjcnventura
#6 Screenshot from 2019-09-07 11-48-30.png32.05 KBjcnventura
#2 stackpath-coding-standards-3079446-2.patch21.38 KBjcnventura

Comments

jcnventura created an issue. See original summary.

jcnventura’s picture

jcnventura
Primary language English
commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new stackpath-coding-standards-3079446-2.patch21.38 KB
a.dmitriiev’s picture

a.dmitriiev commented

There is now problem with configuration. The properties in the class are now camel cased, and the schema expects underscores. The purger settings can't be saved.

jcnventura’s picture

jcnventura
Primary language English
commented
Related issues: +#2411967: Allow config entities to specify the config key <-> entity property mapping

Yes, it would seem this should be possible to solve properly (https://www.drupal.org/node/2481909), but there are still some issues #2411967: Allow config entities to specify the config key <-> entity property mapping.

jcnventura’s picture

jcnventura
Primary language English
commented
StatusFileSize
new Screenshot from 2019-09-07 11-48-30.png32.05 KB
new stackpath-coding-standards-3079446-6.patch794 bytes

Nice! But since the solution will not show up anytime soon, let's ignore this known coding standard violation.

3 errors

This new patch makes the phpcs code sniffer ignore these errors.

Status: Needs review » Needs work

The last submitted patch, 6: stackpath-coding-standards-3079446-6.patch, failed testing. View results

  • jcnventura authored ada4886 on 8.x-1.x 
    Issue #3079446 by jcnventura, a.dmitriiev: Fix coding standard...
jcnventura’s picture

jcnventura
Primary language English
commented
Status: Needs work » Fixed
a.dmitriiev’s picture

a.dmitriiev commented

Alpha3 version was released with the changes, thanks @jcnventura

breidert’s picture

breidert commented
Status: Fixed » Closed (fixed)