Fix the issues reported by PHP_CodeSniffer

Created on 25 September 2024, about 2 months ago

Problem/Motivation

FILE: svg_icon\src\Plugin\EntityReferenceSelection\SvgSelection.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------------
6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\file\FileInterface.
28 | WARNING | [x] '@todo, find out why temporary files are created.' should match the format '@todo Fix problem X here.'
---------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------

FILE: svg_icon\src\Plugin\Field\FieldFormatter\SvgIconFormatter.php
----------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------
6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Field\FieldItemListInterface.
----------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------------------

FILE: svg_icon\src\Plugin\Field\FieldType\SvgIcon.php
-----------------------------------------------------------------------------------
FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES
-----------------------------------------------------------------------------------
5 | WARNING | [x] Unused use statement
6 | WARNING | [x] Unused use statement
7 | WARNING | [x] Unused use statement
9 | WARNING | [x] Unused use statement
31 | WARNING | [ ] Possible useless method overriding detected
-----------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------

FILE: svg_icon\src\Plugin\Field\FieldWidget\SvgIconWidget.php
---------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AND 5 WARNINGS AFFECTING 7 LINES
---------------------------------------------------------------------------------------------------------------------------------------
6 | WARNING | [x] Unused use statement
71 | WARNING | [x] '@todo, possibly allow user to choose autocomplete vs select.' should match the format '@todo Fix problem X
| | here.'
73 | ERROR | [ ] Comment indentation error, expected only 1 spaces
119 | WARNING | [x] '@todo, properly evaluate and address security concerns instead of' should match the format '@todo Fix problem X
| | here.'
141 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
202 | ERROR | [ ] The array declaration extends to column 138 (the limit is 120). The array content should be split up over
| | multiple lines
208 | WARNING | [x] A comma should follow the last multiline array item. Found: ''
---------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------------------

FILE: svg_icon\src\Svg.php
-----------------------------------------------------------------------------------------------------------------------------
FOUND 14 ERRORS AFFECTING 14 LINES
-----------------------------------------------------------------------------------------------------------------------------
5 | ERROR | [ ] Missing short description in doc comment
14 | ERROR | [ ] Missing member variable doc comment
15 | ERROR | [ ] Missing member variable doc comment
16 | ERROR | [ ] Missing member variable doc comment
17 | ERROR | [ ] Missing member variable doc comment
22 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
53 | ERROR | [x] Missing function doc comment
57 | ERROR | [x] Missing function doc comment
61 | ERROR | [x] Missing function doc comment
85 | ERROR | [x] Missing function doc comment
89 | ERROR | [ ] Missing short description in doc comment
90 | ERROR | [ ] Description for the @return value is missing
96 | ERROR | [x] Missing function doc comment
100 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------

FILE: svg_icon\svg_icon.info.yml
-------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------
1 | WARNING | Remove "project" from the info file, it will be added by drupal.org packaging automatically
1 | WARNING | Remove "datestamp" from the info file, it will be added by drupal.org packaging automatically
1 | WARNING | Remove "version" from the info file, it will be added by drupal.org packaging automatically
-------------------------------------------------------------------------------------------------------------

Steps to reproduce

Run phpcs command to get the drupal coding standard issues.

Proposed resolution

Many of the issues can be fixed by running the phpcbf command. For the remaining ones, we will need to manually address and then commit these changes before pushing them.

📌 Task
Status

Needs work

Version

2.0

Component

Code

Created by

🇺🇸United States sunil jolapara 3265 Summitrun Drive, Independence, KY, 41051

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