Problem/Motivation
Fix phpcs errors for
- Drupal.Commenting.DocComment
- Drupal.Commenting.FunctionComment
- Drupal.Commenting.InlineVariableComment
- Drupal.Commenting.ClassComment
- Drupal.Commenting.DataTypeNamespace
- Drupal.Commenting.Deprecated
- Drupal.Commenting.FileComment
- Drupal.Commenting.InlineComment
Command:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml,twig modules/custom/pathauto/ --sniffs="Drupal.Commenting.DocComment,Drupal.Commenting.FunctionComment,Drupal.Commenting.InlineVariableComment,Drupal.Commenting.ClassComment,Drupal.Commenting.DataTypeNamespace,Drupal.Commenting.Deprecated,Drupal.Commenting.FileComment,Drupal.Commenting.InlineComment"
Result:
FILE: /tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module
-------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------
1 | ERROR | [x] Missing file doc comment
-------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------
FILE: /tests/src/Functional/PathautoNodeWebTest.php
--------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------
182 | ERROR | Missing short description in doc comment
--------------
FILE: /tests/src/Functional/PathautoBulkUpdateTest.php
-----------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------
73 | ERROR | [x] Missing function doc comment
-----------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------
FILE: /tests/src/Functional/PathautoEnablingEntityTypesTest.php
---
FOUND 1 ERROR AFFECTING 1 LINE
---
61 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
---
FILE: /tests/src/Kernel/PathautoTokenTest.php
--------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 3 LINES
--------
23 | ERROR | [x] Missing function doc comment
39 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
124 | ERROR | [x] Missing function doc comment
--------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------
FILE: /tests/src/Kernel/PathautoEntityWithStringIdTest.php
---------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------
78 | ERROR | [ ] Parameter tags must be defined first in a doc comment
79 | ERROR | [x] Parameter comment must end with a full stop
---------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------
FILE: /tests/src/FunctionalJavascript/PathautoLocaleTest.php
---
FOUND 1 ERROR AFFECTING 1 LINE
---
45 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
---
FILE: /tests/src/FunctionalJavascript/PathautoUiTest.php
-------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------
60 | ERROR | [x] Missing function doc comment
70 | ERROR | [x] Missing function doc comment
-------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------
FILE: /pathauto.api.php
---------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------
10 | ERROR | Missing short description in doc comment
---------------------------------
FILE: /pathauto.module
----
FOUND 1 ERROR AFFECTING 1 LINE
----
151 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
----
FILE: /src/PathautoGeneratorInterface.php
-------
FOUND 10 ERRORS AFFECTING 7 LINES
-------
13 | ERROR | [ ] Doc comment short description must start with a capital letter
13 | ERROR | [ ] Doc comment short description must end with a full stop
18 | ERROR | [ ] Doc comment short description must start with a capital letter
18 | ERROR | [ ] Doc comment short description must end with a full stop
23 | ERROR | [ ] Doc comment short description must start with a capital letter
23 | ERROR | [ ] Doc comment short description must end with a full stop
53 | ERROR | [ ] Description for the @return value is missing
76 | ERROR | [x] Data types in @param tags need to be fully namespaced
81 | ERROR | [ ] Parameter comment must start with a capital letter
82 | ERROR | [x] Parameter comment must end with a full stop
-------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------
FILE: /src/Entity/PathautoPattern.php
FOUND 4 ERRORS AFFECTING 4 LINES
101 | ERROR | [ ] Missing short description in doc comment
127 | ERROR | [ ] Missing short description in doc comment
132 | ERROR | [ ] Missing short description in doc comment
410 | ERROR | [x] Parameter comment must end with a full stop
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
FILE: /src/Form/PatternEditForm.php
-----------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-----------------------------------
25 | ERROR | [ ] Missing short description in doc comment
112 | ERROR | [x] Inline comments must start with a capital letter
-----------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------
FILE: /src/Plugin/Deriver/EntityAliasTypeDeriver.php
---------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------
23 | ERROR | Missing short description in doc comment
35 | ERROR | Missing short description in doc comment
---------------
FILE: /src/Plugin/pathauto/AliasType/EntityAliasTypeBase.php
FOUND 2 ERRORS AFFECTING 1 LINE
300 | ERROR | The text '@deprecated Use \Drupal\pathauto\PathautoState::bulkDelete() instead.' does not match the standard format: @deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%.
300 | ERROR | Each @deprecated tag must have a @see tag immediately following it
FILE: /src/EventSubscriber/PathautoSettingsCacheTag.php
------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------
16 | ERROR | Missing short description in doc comment
------------------
FILE: /src/AliasStorageHelperInterface.php
-----
FOUND 1 ERROR AFFECTING 1 LINE
-----
105 | ERROR | Missing parameter type
-----
FILE: /src/PathautoFieldItemList.php
------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------
7 | ERROR | [x] Missing class doc comment
9 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [ ] Missing short description in doc comment
------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------
FILE: /src/PathautoState.php
---------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------------------
30 | ERROR | Missing short description in doc comment
123 | ERROR | Description for the @return value is missing
---------------------------------
FILE: /src/PathautoPatternInterface.php
--
FOUND 11 ERRORS AFFECTING 11 LINES
--
15 | ERROR | Description for the @return value is missing
22 | ERROR | Missing parameter comment
31 | ERROR | Description for the @return value is missing
35 | ERROR | Missing short description in doc comment
36 | ERROR | Description for the @return value is missing
43 | ERROR | Description for the @return value is missing
60 | ERROR | Description for the @return value is missing
128 | ERROR | Description for the @return value is missing
149 | ERROR | Description for the @return value is missing
174 | ERROR | Missing parameter type
177 | ERROR | Description for the @return value is missing
--
FILE: /src/PathautoPatternListBuilder.php
----
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----
40 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
----
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----
FILE: /src/AliasCleanerInterface.php
------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------
5 | ERROR | Missing short description in doc comment
------------------------------------
FILE: /src/Commands/PathautoCommands.php
--------
FOUND 11 ERRORS AFFECTING 11 LINES
--------
65 | ERROR | [ ] Doc comment short description must start with a capital letter
69 | ERROR | [ ] Parameter tags must be defined first in a doc comment
107 | ERROR | [ ] Parameter $options is not described in comment
108 | ERROR | [x] Doc comment short description must end with a full stop
112 | ERROR | [ ] Parameter tags must be defined first in a doc comment
170 | ERROR | [ ] Missing short description in doc comment
183 | ERROR | [ ] Missing short description in doc comment
197 | ERROR | [ ] Missing short description in doc comment
201 | ERROR | [ ] @throws tag comment must end with a full stop
216 | ERROR | [ ] Missing short description in doc comment
220 | ERROR | [ ] @throws tag comment must end with a full stop
--------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------
Steps to reproduce
Proposed resolution
Remaining tasks
User interface changes
API changes
Data model changes