Fix the issues reported by phpcs

Open on Drupal.org →

Created on 27 January 2023, about 2 years ago

Updated 29 February 2024, about 1 year ago

Problem/Motivation

Getting following error/warnings

FILE: /var/www/html/modules/contrib/wordfilter/wordfilter.links.action.yml
--------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------
5 | ERROR | [x] Expected 1 newline at end of file; 2 found
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/wordfilter.links.menu.yml
------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------
7 | ERROR | [x] Expected 1 newline at end of file; 2 found
------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/tests/src/Unit/DefaultWordfilterProcessUnitTest.php
--------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AND 1 WARNING AFFECTING 14 LINES
--------------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
15 | ERROR | [ ] Missing short description in doc comment
18 | ERROR | [ ] Class property $wordfilter_process should use lowerCamel naming without underscores
19 | ERROR | [x] Whitespace found at end of line
25 | ERROR | [x] Whitespace found at end of line
34 | ERROR | [ ] Missing parameter type
36 | ERROR | [ ] Missing parameter type
42 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
56 | WARNING | [x] 'TODO Add more reasonable data sets.' should match the format '@todo Fix problem X here.'
58 | ERROR | [ ] Description for the @return value is missing
67 | ERROR | [x] Expected 1 blank line after function; 0 found
68 | ERROR | [x] The closing brace for the class must have an empty line before it
--------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/tests/src/Unit/WordfilterConfigurationUnitTest.php
-----------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
-----------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
15 | ERROR | [ ] Missing short description in doc comment
18 | ERROR | [ ] Class property $wordfilter_config should use lowerCamel naming without underscores
28 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
81 | ERROR | [x] Expected 1 blank line after function; 0 found
82 | ERROR | [x] The closing brace for the class must have an empty line before it
-----------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/tests/src/Unit/TokenWordfilterProcessUnitTest.php
---------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AND 2 WARNINGS AFFECTING 17 LINES
---------------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
14 | ERROR | [ ] Missing short description in doc comment
17 | ERROR | [ ] Class property $wordfilter_process should use lowerCamel naming without underscores
43 | ERROR | [ ] Missing parameter type
45 | ERROR | [ ] Missing parameter type
51 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
65 | WARNING | [x] 'TODO Add more reasonable data sets.' should match the format '@todo Fix problem X here.'
67 | ERROR | [ ] Description for the @return value is missing
83 | ERROR | [ ] Missing parameter type
85 | ERROR | [ ] Missing parameter type
91 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
105 | WARNING | [x] 'TODO Add more reasonable data sets.' should match the format '@todo Fix problem X here.'
107 | ERROR | [ ] Description for the @return value is missing
116 | ERROR | [x] Expected 1 blank line after function; 0 found
117 | ERROR | [x] The closing brace for the class must have an empty line before it
---------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/tests/src/Functional/WordfilterApplianceTest.php
---------------------------------------------------------------------------------------------------------------------------------------
FOUND 67 ERRORS AND 3 WARNINGS AFFECTING 66 LINES
---------------------------------------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
14 | ERROR | [x] Expected 1 space before opening brace; found 2
15 | ERROR | [ ] Missing member variable doc comment
17 | ERROR | [ ] Missing member variable doc comment
19 | ERROR | [ ] Missing member variable doc comment
21 | ERROR | [ ] Missing short description in doc comment
23 | ERROR | [ ] Missing @var tag in member variable comment
25 | ERROR | [x] Whitespace found at end of line
26 | ERROR | [ ] Class property $wordfilter_config_id should use lowerCamel naming without underscores
26 | ERROR | [ ] Missing member variable doc comment
28 | ERROR | [x] Missing function doc comment
38 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
45 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 3
46 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
47 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
49 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
50 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
50 | ERROR | [x] Concat operator must be surrounded by a single space
51 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
52 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
53 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
60 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
60 | ERROR | [x] Concat operator must be surrounded by a single space
61 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
62 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
63 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
64 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
65 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
66 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
68 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
69 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
70 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
72 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
72 | ERROR | [x] Concat operator must be surrounded by a single space
73 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
74 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
75 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
76 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
77 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
78 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 5
79 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 3
88 | ERROR | [x] Whitespace found at end of line
93 | ERROR | [x] Whitespace found at end of line
101 | ERROR | [x] Whitespace found at end of line
106 | ERROR | [x] Whitespace found at end of line
115 | ERROR | [x] Whitespace found at end of line
120 | ERROR | [x] Whitespace found at end of line
133 | WARNING | [x] A comma should follow the last multiline array item. Found: 'Lorem, Ipsum, Dolor'
143 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
145 | ERROR | [ ] Protected method name "WordfilterApplianceTest::addWordfilterConfigToBasicHTMLFormat" is not in lowerCamel format
158 | ERROR | [x] Whitespace found at end of line
161 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
163 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 3
166 | ERROR | [x] Whitespace found at end of line
170 | ERROR | [x] Whitespace found at end of line
174 | ERROR | [x] Closing brace indented incorrectly; expected 3 spaces, found 2
175 | ERROR | [x] Whitespace found at end of line
178 | ERROR | [ ] Doc comment short description must be on a single line, further text should be a separate paragraph
183 | ERROR | [x] Whitespace found at end of line
187 | ERROR | [x] Whitespace found at end of line
192 | ERROR | [x] Whitespace found at end of line
198 | ERROR | [x] Whitespace found at end of line
203 | ERROR | [x] Whitespace found at end of line
207 | ERROR | [x] Whitespace found at end of line
216 | ERROR | [ ] Description for the @return value is missing
227 | WARNING | [x] A comma should follow the last multiline array item. Found: 'basic_html'
228 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
234 | ERROR | [x] Expected 1 blank line after function; 0 found
235 | ERROR | [x] The closing brace for the class must have an empty line before it
---------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 58 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
----------------------------------------------------------------------
4 | WARNING | Line exceeds 80 characters; contains 82 characters
8 | WARNING | Line exceeds 80 characters; contains 93 characters
11 | WARNING | Line exceeds 80 characters; contains 224 characters
----------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/wordfilter.module
---------------------------------------------------------------------------------------------------------------------------------------------
FOUND 35 ERRORS AND 9 WARNINGS AFFECTING 34 LINES
---------------------------------------------------------------------------------------------------------------------------------------------
9 | ERROR | [x] When importing a class with "use", do not include a leading \
10 | ERROR | [x] When importing a class with "use", do not include a leading \
11 | ERROR | [x] When importing a class with "use", do not include a leading \
12 | ERROR | [x] When importing a class with "use", do not include a leading \
26 | ERROR | [ ] The array declaration extends to column 358 (the limit is 80). The array content should be split up over multiple lines
37 | WARNING | [ ] Hook implementations should not duplicate @param documentation
37 | ERROR | [ ] Missing parameter comment
38 | WARNING | [ ] Hook implementations should not duplicate @param documentation
38 | ERROR | [ ] Missing parameter comment
39 | WARNING | [ ] Hook implementations should not duplicate @param documentation
39 | ERROR | [ ] Missing parameter comment
41 | ERROR | [ ] Type hint "array" missing for &$form
47 | ERROR | [x] Whitespace found at end of line
48 | WARNING | [ ] Hook implementations should not duplicate @param documentation
48 | ERROR | [ ] Missing parameter comment
49 | WARNING | [ ] Hook implementations should not duplicate @param documentation
49 | ERROR | [ ] Missing parameter comment
50 | WARNING | [ ] Hook implementations should not duplicate @param documentation
50 | ERROR | [ ] Missing parameter comment
52 | ERROR | [ ] Type hint "array" missing for &$form
58 | ERROR | [x] Whitespace found at end of line
61 | ERROR | [x] Whitespace found at end of line
67 | ERROR | [ ] Type hint "array" missing for &$form
75 | ERROR | [x] Whitespace found at end of line
83 | ERROR | [x] Whitespace found at end of line
120 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
126 | ERROR | [ ] Type hint "\Drupal\Core\Config\Entity\ThirdPartySettingsInterface" missing for $entity
126 | ERROR | [ ] Type hint "array" missing for &$form
136 | WARNING | [ ] Hook implementations should not duplicate @param documentation
136 | ERROR | [ ] Missing parameter comment
137 | WARNING | [ ] Hook implementations should not duplicate @param documentation
137 | ERROR | [ ] Missing parameter comment
139 | ERROR | [ ] Type hint "array" missing for $build
139 | ERROR | [ ] Type hint "array" missing for $context
148 | ERROR | [x] Case breaking statements must be followed by a single blank line
151 | ERROR | [x] Case breaking statements must be followed by a single blank line
155 | ERROR | [x] Whitespace found at end of line
164 | ERROR | [x] Whitespace found at end of line
167 | ERROR | [x] Whitespace found at end of line
198 | ERROR | [x] Whitespace found at end of line
202 | ERROR | [x] Whitespace found at end of line
207 | ERROR | [x] Whitespace found at end of line
210 | ERROR | [x] Whitespace found at end of line
216 | ERROR | [x] Whitespace found at end of line
---------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 19 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Form/WordfilterConfigurationForm.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AND 14 WARNINGS AFFECTING 25 LINES
----------------------------------------------------------------------------------------------------------------------------------------------
15 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
18 | ERROR | [ ] Missing short description in doc comment
19 | ERROR | [ ] Description for the @return value is missing
28 | ERROR | [ ] Missing parameter comment
31 | ERROR | [x] Separate the @param and @return sections by a blank line.
34 | ERROR | [ ] Type hint "array" missing for &$old_form
36 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
72 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
80 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
100 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
110 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
130 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
139 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
151 | ERROR | [x] Trailing punctuation for @see references is not allowed.
163 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
184 | ERROR | [x] Trailing punctuation for @see references is not allowed.
195 | ERROR | [x] Trailing punctuation for @see references is not allowed.
209 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
232 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency injection instead
236 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
244 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
251 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
265 | ERROR | [x] Trailing punctuation for @see references is not allowed.
280 | ERROR | [x] Trailing punctuation for @see references is not allowed.
292 | ERROR | [x] Trailing punctuation for @see references is not allowed.
----------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/WordfilterPermissions.php
------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------
45 | ERROR | [x] Short array syntax must be used to define arrays
53 | ERROR | [x] Expected 1 blank line after function; 0 found
54 | 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: /var/www/html/modules/contrib/wordfilter/src/Entity/WordfilterConfiguration.php
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 15 ERRORS AFFECTING 13 LINES
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
68 | ERROR | [x] Whitespace found at end of line
72 | ERROR | [x] Whitespace found at end of line
75 | ERROR | [x] Whitespace found at end of line
77 | ERROR | [x] Whitespace found at end of line
78 | ERROR | [ ] The @var tag must be the first tag in a member variable comment
78 | ERROR | [x] Whitespace found at end of line
78 | ERROR | [x] Expected "\Drupal\wordfilter\Plugin\WordfilterProcessInterface" but found "\Drupal\wordfilter\Plugin\WordfilterProcessInterface " for @var tag in member
| | variable comment
80 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 3
113 | ERROR | [x] Whitespace found at end of line
148 | ERROR | [ ] The array declaration extends to column 88 (the limit is 80). The array content should be split up over multiple lines
173 | ERROR | [x] Expected 1 blank line after function; 0 found
174 | ERROR | [x] The closing brace for the class must have an empty line before it
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 13 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Entity/WordfilterConfigurationInterface.php
------------------------------------------------------------------------------------------------
FOUND 14 ERRORS AFFECTING 13 LINES
------------------------------------------------------------------------------------------------
14 | ERROR | [x] Whitespace found at end of line
18 | ERROR | [x] Expected 1 blank line before function; 0 found
19 | ERROR | [x] Whitespace found at end of line
22 | ERROR | [x] Whitespace found at end of line
24 | ERROR | [x] Whitespace found at end of line
24 | ERROR | [x] Parameter comment must end with a full stop
26 | ERROR | [x] Namespaced classes/interfaces/traits should be referenced with use statements
32 | ERROR | [x] Return comment indentation must be 3 spaces, found 2 spaces
41 | ERROR | [x] Expected "int" but found "integer" for parameter type
44 | ERROR | [ ] Description for the @return value is missing
54 | ERROR | [ ] Missing parameter comment
55 | ERROR | [x] Separate the @param and @return sections by a blank line.
58 | ERROR | [x] Expected 1 blank line after function; 0 found
59 | ERROR | [x] The closing brace for the interface must have an empty line before it
------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Plugin/WordfilterProcessBase.php
------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 10 ERRORS AND 2 WARNINGS AFFECTING 11 LINES
------------------------------------------------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
8 | ERROR | [x] When importing a class with "use", do not include a leading \
16 | ERROR | [x] Whitespace found at end of line
19 | ERROR | [x] Whitespace found at end of line
23 | ERROR | [x] Expected 1 blank line before function; 0 found
42 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
42 | WARNING | [ ] Do not concatenate strings to translatable strings, they should be part of the t() argument and you should use placeholders
44 | ERROR | [x] Closing parenthesis of array declaration must be on a new line
45 | ERROR | [x] Expected 1 blank line after function; 0 found
46 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 10 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Plugin/WordfilterProcessInterface.php
----------------------------------------------------------------------------------------
FOUND 15 ERRORS AFFECTING 15 LINES
----------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
8 | ERROR | [x] When importing a class with "use", do not include a leading \
19 | ERROR | [x] Parameter comment indentation must be 3 spaces, found 2 spaces
21 | ERROR | [x] Parameter comment indentation must be 3 spaces, found 2 spaces
23 | ERROR | [x] Parameter comment indentation must be 3 spaces, found 2 spaces
29 | ERROR | [x] Whitespace found at end of line
32 | ERROR | [x] Whitespace found at end of line
35 | ERROR | [x] Data types in @param tags need to be fully namespaced
37 | ERROR | [x] Data types in @param tags need to be fully namespaced
39 | ERROR | [x] Whitespace found at end of line
40 | ERROR | [ ] Return type missing for @return tag in function comment
43 | ERROR | [x] Expected 1 blank line after function; 0 found
44 | ERROR | [x] The closing brace for the interface must have an empty line before it
----------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 14 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Plugin/WordfilterProcess/DefaultWordfilterProcess.php
--------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
--------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
8 | ERROR | [x] When importing a class with "use", do not include a leading \
10 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [x] Expected 1 blank line before function; 0 found
32 | ERROR | [x] Expected 1 blank line after function; 0 found
33 | ERROR | [x] The closing brace for the class must have an empty line before it
--------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Plugin/WordfilterProcess/TokenWordfilterProcess.php
------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
------------------------------------------------------------------------------------------------------
5 | ERROR | [x] When importing a class with "use", do not include a leading \
6 | ERROR | [x] When importing a class with "use", do not include a leading \
7 | ERROR | [x] When importing a class with "use", do not include a leading \
8 | ERROR | [x] When importing a class with "use", do not include a leading \
10 | ERROR | [ ] Missing short description in doc comment
21 | ERROR | [x] Expected 1 blank line before function; 0 found
33 | ERROR | [x] Expected 1 blank line after function; 0 found
34 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Plugin/Filter/WordFilter.php
----------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 10 LINES
----------------------------------------------------------------------------------------------------
6 | WARNING | [x] Unused use statement
10 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [ ] The @var tag must be the first tag in a member variable comment
27 | ERROR | [ ] Class property $active_configs should use lowerCamel naming without underscores
32 | ERROR | [ ] Description for the @return value is missing
86 | ERROR | [x] Short array syntax must be used to define arrays
91 | ERROR | [x] Array indentation error, expected 6 spaces but found 8
92 | ERROR | [x] Expected 1 space after "=>"; 2 found
97 | ERROR | [x] Expected 1 blank line after function; 0 found
98 | ERROR | [x] The closing brace for the class must have an empty line before it
----------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/Annotation/WordfilterProcess.php
------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------
41 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/WordfilterItem.php
------------------------------------------------------------------------------------------------------------------------
FOUND 19 ERRORS AND 1 WARNING AFFECTING 18 LINES
------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
30 | ERROR | [ ] Parameter $parent is not described in comment
46 | ERROR | [ ] Description for the @return value is missing
55 | ERROR | [ ] Missing parameter comment
64 | ERROR | [ ] Missing parameter comment
66 | ERROR | [ ] Type hint "array" missing for &$data
73 | ERROR | [x] Expected "int" but found "integer" for function return type
73 | ERROR | [ ] Description for the @return value is missing
82 | ERROR | [ ] Missing parameter comment
82 | ERROR | [ ] Missing parameter type
91 | ERROR | [ ] Description for the @return value is missing
111 | ERROR | [x] Return comment indentation must be 3 spaces, found 2 spaces
129 | WARNING | [x] 'Todo Replace with a case-insensitive filter.' should match the format '@todo Fix problem X here.'
139 | ERROR | [ ] Missing parameter type
140 | ERROR | [x] Parameter comment indentation must be 3 spaces, found 2 spaces
141 | ERROR | [x] Separate the @param and @return sections by a blank line.
142 | ERROR | [x] Return comment indentation must be 3 spaces, found 2 spaces
153 | ERROR | [ ] Description for the @return value is missing
157 | ERROR | [x] Expected 1 blank line after function; 0 found
158 | ERROR | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------

FILE: /var/www/html/modules/contrib/wordfilter/src/WordfilterConfigurationAccessControlHandler.php
--------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 2 WARNINGS AFFECTING 5 LINES
--------------------------------------------------------------------------------------------------
6 | WARNING | [x] Unused use statement
7 | WARNING | [x] Unused use statement
42 | ERROR | [x] Short array syntax must be used to define arrays
52 | ERROR | [x] Expected 1 blank line after function; 0 found
53 | ERROR | [x] The closing brace for the class must have an empty line before it
--------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------

Time: 3.74 secs; Memory: 6MB

Steps to reproduce

Run following command

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml modules/contrib/wordfilter/

Proposed resolution

Above error/warnings need to be fixed.

📌 Task

Status

Needs work

Version

2.0

Component

Code

Created by

🇮🇳India samit.310@gmail.com

Live updates comments and jobs are added and updated live.

Coding standards
It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Issue created by @samit.310@gmail.com
Comment about 2 years ago →
🇮🇳India samit.310@gmail.com
Above error/warnings are fixed.
Comment about 2 years ago →
🇮🇳India Charchil Khandelwal
Charchil Khandelwal → made their first commit to this issue’s fork.
Assigned to Charchil Khandelwal
Comment about 2 years ago →
🇮🇳India Charchil Khandelwal
I will review this.
Issue was unassigned.
Status changed to Needs review about 2 years ago4:56am 27 January 2023
Comment about 2 years ago →
🇮🇳India Charchil Khandelwal
Created MR for this issue.
Please review.

Thank You.
@charchil-khandelwal opened merge request.
Comment about 2 years ago →
🇮🇳India Charchil Khandelwal
Please review.
Thank You.
Comment about 2 years ago →
gaurav-mathur
Thanks @samit.310@gmail.com and @Charchil Khandelwal, All the errors have been resolved. Hence, moving to RTBC.
Status changed to Needs work almost 2 years ago4:00pm 1 May 2023

Comment almost 2 years ago →

🇮🇹Italy apaderno Brescia, 🇮🇹

   /**
    * The assigned Wordfilter process object.
-   * 
+   *
+   * @var \Drupal\wordfilter\Plugin\WordfilterProcessInterface
+   *   The Wordfilter Process Interface.

The short description is given before @var, not after.

/**
- * Class WordfilterConfigurationForm.
+ * The WordfilterConfigurationForm Class.

The short description is still repeating the class name, which is what the report said to avoid.

+  /**
+   * The Wordfilter Process Manager.
+   *
+   * @var \Drupal\wordfilter\Plugin\WordfilterProcessManager
+   */
+  protected $wordfilterProcess;

All the words in the short description, expect the first, are misspelled.

+  /**
+   * Constructs an WordfilterConfigurationForm object.

The class namespace is missing.

+  /**
+   * Get the Wordfilter Configuration.
+   *
    * @return \Drupal\wordfilter\Entity\WordfilterConfigurationInterface
+   *   The Wordfilter Configuration.

Configuration is misspelled.

First commit to issue fork.
First commit to issue fork.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024