Contrib.social

Coding standards issue

Open on Drupal.org ā†’
Created on 7 February 2025, 3 months ago

Problem/Motivation

FILE: ...synimport/src/Drush/Commands/SynimportCommands.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AFFECTING 9 LINES
-------------------------------------------------------------------------------------------------------------------------------
69 | ERROR | Parameter tags must be grouped together in a doc comment
89 | ERROR | Parameter tags must be grouped together in a doc comment
109 | ERROR | Parameter tags must be grouped together in a doc comment
112 | ERROR | Parameter tags must be grouped together in a doc comment
133 | ERROR | Parameter tags must be grouped together in a doc comment
136 | ERROR | Parameter tags must be grouped together in a doc comment
157 | ERROR | Parameter tags must be grouped together in a doc comment
160 | ERROR | Parameter tags must be grouped together in a doc comment
193 | ERROR | Parameter $source is not described in comment
-------------------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Product.php
---------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
---------------------------------------------------------------------------------------------------------------------
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
39 | ERROR | [ ] Missing parameter comment
61 | ERROR | [x] Expected newline after closing brace
---------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Files.php
----------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 2 WARNINGS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------------------
19 | ERROR | [x] Data types in @var tags need to be fully namespaced
87 | WARNING | [x] '@TODO: FileSystemInterface::EXISTS_RENAME.' should match the format '@todo Fix problem X here.'
135 | WARNING | [x] '@TODO: FileSystemInterface::EXISTS_RENAME.' should match the format '@todo Fix problem X here.'
----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Import.php
--------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 1 WARNING AFFECTING 9 LINES
--------------------------------------------------------------------------------------------------------------------
20 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
81 | ERROR | Missing parameter comment
82 | ERROR | Missing parameter comment
83 | ERROR | Missing parameter comment
84 | ERROR | Missing parameter comment
85 | ERROR | Missing parameter comment
86 | ERROR | Missing parameter comment
87 | ERROR | Missing parameter comment
166 | ERROR | Doc comment is empty
--------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Node.php
------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------------------------
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
32 | ERROR | [ ] Missing parameter comment
54 | ERROR | [x] Expected newline after closing brace
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Menu.php
------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------------------------
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
32 | ERROR | [ ] Missing parameter comment
54 | ERROR | [x] Expected newline after closing brace
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Taxonomy.php
----------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------------------
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
32 | ERROR | [ ] Missing parameter comment
56 | ERROR | [x] Expected newline after closing brace
----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/CreateEntity.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 19 ERRORS AND 1 WARNING AFFECTING 19 LINES
--------------------------------------------------------------------------------------------------------------------------
12 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
17 | ERROR | [x] Data types in @var tags need to be fully namespaced
59 | ERROR | [ ] Missing parameter comment
101 | ERROR | [x] Expected newline after closing brace
201 | ERROR | [x] Expected newline after closing brace
238 | ERROR | [x] Expected newline after closing brace
250 | ERROR | [x] Expected newline after closing brace
281 | ERROR | [x] Expected newline after closing brace
286 | ERROR | [x] Expected newline after closing brace
304 | ERROR | [x] Expected newline after closing brace
306 | ERROR | [x] Expected newline after closing brace
314 | ERROR | [x] Expected newline after closing brace
327 | ERROR | [x] Expected newline after closing brace
342 | ERROR | [x] Expected newline after closing brace
344 | ERROR | [x] Expected newline after closing brace
354 | ERROR | [x] Expected newline after closing brace
356 | ERROR | [x] Expected newline after closing brace
375 | ERROR | [x] Expected newline after closing brace
375 | ERROR | [x] Expected 1 space after ELSE keyword; 2 found
438 | ERROR | [x] Expected newline after closing brace
--------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 18 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Block.php
-------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
-------------------------------------------------------------------------------------------------------------------
18 | ERROR | [x] Data types in @var tags need to be fully namespaced
32 | ERROR | [ ] Missing parameter comment
54 | ERROR | [x] Expected newline after closing brace
-------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Import/Redis.php
-------------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 2 WARNINGS AFFECTING 4 LINES
-------------------------------------------------------------------------------------------------------------------------------
91 | ERROR | [x] Inline comments must start with a capital letter
92 | WARNING | [ ] Line exceeds 80 characters; contains 81 characters
92 | ERROR | [ ] Comment indentation error, expected only 1 spaces
94 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
130 | WARNING | [ ] Line exceeds 80 characters; contains 107 characters
-------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/CreateYml.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AND 2 WARNINGS AFFECTING 9 LINES
-----------------------------------------------------------------------------------------------------------------------
5 | WARNING | [x] Unused use statement
10 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
15 | ERROR | [x] Data types in @var tags need to be fully namespaced
77 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
170 | ERROR | [x] Use "elseif" in place of "else if"
191 | ERROR | [x] Expected newline after closing brace
198 | ERROR | [x] Expected newline after closing brace
267 | ERROR | [x] Expected newline after closing brace
274 | ERROR | [x] Expected newline after closing brace
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/Product.php
---------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------------------------------------------------------------------------------------------------------
17 | ERROR | [x] Data types in @var tags need to be fully namespaced
31 | ERROR | [ ] Missing parameter comment
---------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/CreateYmlBase.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------
11 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
---------------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/Node.php
------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
------------------------------------------------------------------------------------------------------------------
17 | ERROR | [x] Data types in @var tags need to be fully namespaced
31 | ERROR | [ ] Missing parameter comment
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/Taxonomy.php
----------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------------------------------------------------------
17 | ERROR | [x] Data types in @var tags need to be fully namespaced
31 | ERROR | [ ] Missing parameter comment
----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/Block.php
-------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------
17 | ERROR | [x] Data types in @var tags need to be fully namespaced
31 | ERROR | [ ] Missing parameter comment
-------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Export/Export.php
---------------------------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 1 WARNING AFFECTING 8 LINES
---------------------------------------------------------------------------------------------------------------------
16 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
21 | ERROR | [x] Data types in @var tags need to be fully namespaced
70 | ERROR | [ ] Missing parameter comment
70 | ERROR | [ ] Doc comment for parameter $menuExport does not match actual variable name $blockExport
71 | ERROR | [ ] Missing parameter comment
72 | ERROR | [ ] Missing parameter comment
73 | ERROR | [ ] Missing parameter comment
74 | ERROR | [ ] Missing parameter comment
75 | ERROR | [ ] Missing parameter comment
75 | ERROR | [ ] Superfluous parameter comment
---------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------

FILE: ...synimport/src/Service/Logger.php
-------------------------------------------------------------------------------------------------------------
FOUND 30 ERRORS AFFECTING 15 LINES
-------------------------------------------------------------------------------------------------------------
23 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
23 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
24 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
24 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
25 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
25 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
26 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
26 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
27 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
27 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
28 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
28 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
29 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
29 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
30 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
30 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
31 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
31 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
32 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
32 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
33 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
33 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
34 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
34 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
35 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
35 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
36 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
36 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
37 | ERROR | [x] Spaces must be used to indent lines; tabs are not allowed
37 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 2
-------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 30 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------

Time: 340ms; Memory: 12MB

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

šŸ“Œ Task
Status

Active

Version

1.0

Component

Code

Created by

šŸ‡ØšŸ‡“Colombia kinyein

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

Merge Requests

Comments & Activities

  • Issue created by @kinyein
  • Merge request !2Coding standards fix ā†’ (Open) created by kinyein
  • Comment 3 months ago ā†’
    šŸ‡ØšŸ‡“Colombia kinyein

    Hi, I made a merge request to fix the coding standards issue in this module, I hope it can be reviewed soon.

  • Comment 3 months ago ā†’
    šŸ‡µšŸ‡­Philippines clarkssquared

    Hi kinyein,

    I applied and tested your MR !2 and I can still see PHPCS errors on my end.

    āžœ  synimport git:(8.x-1.96) curl https://git.drupalcode.org/project/synimport/-/merge_requests/2.diff | patch -p1 
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 24333    0 24333    0     0  45099      0 --:--:-- --:--:-- --:--:-- 45567
patching file 'src/Drush/Commands/SynimportCommands.php'
patching file 'src/Service/Export/Block.php'
patching file 'src/Service/Export/CreateYml.php'
patching file 'src/Service/Export/CreateYmlBase.php'
patching file 'src/Service/Export/Export.php'
patching file 'src/Service/Export/Node.php'
patching file 'src/Service/Export/Product.php'
patching file 'src/Service/Export/Taxonomy.php'
patching file 'src/Service/Import/Block.php'
patching file 'src/Service/Import/CreateEntity.php'
patching file 'src/Service/Import/Files.php'
patching file 'src/Service/Import/Import.php'
patching file 'src/Service/Import/Menu.php'
patching file 'src/Service/Import/Node.php'
patching file 'src/Service/Import/Product.php'
patching file 'src/Service/Import/Redis.php'
patching file 'src/Service/Import/Taxonomy.php'
patching file 'src/Service/Logger.php'
āžœ  synimport git:(8.x-1.96) āœ— ..
āžœ  contrib git:(main) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml synimport 

FILE: ...l-project/web/modules/contrib/synimport/content file examples/contacts.yml
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 18 | ERROR | [x] Expected 1 newline at end of file; 2 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...oject/web/modules/contrib/synimport/content file examples/node_project.yml
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 75 | ERROR | [x] Expected 1 newline at end of file; 3 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...jects/drupal-issues/drupal-project/web/modules/contrib/synimport/README.md
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 19 WARNINGS AFFECTING 19 LINES
--------------------------------------------------------------------------------
   4 | WARNING | Line exceeds 80 characters; contains 89 characters
   5 | WARNING | Line exceeds 80 characters; contains 103 characters
  32 | WARNING | Line exceeds 80 characters; contains 101 characters
  62 | WARNING | Line exceeds 80 characters; contains 82 characters
  64 | WARNING | Line exceeds 80 characters; contains 85 characters
  68 | WARNING | Line exceeds 80 characters; contains 125 characters
  69 | WARNING | Line exceeds 80 characters; contains 113 characters
  70 | WARNING | Line exceeds 80 characters; contains 89 characters
  72 | WARNING | Line exceeds 80 characters; contains 81 characters
  74 | WARNING | Line exceeds 80 characters; contains 136 characters
  78 | WARNING | Line exceeds 80 characters; contains 97 characters
  82 | WARNING | Line exceeds 80 characters; contains 113 characters
  86 | WARNING | Line exceeds 80 characters; contains 118 characters
  90 | WARNING | Line exceeds 80 characters; contains 106 characters
 100 | WARNING | Line exceeds 80 characters; contains 104 characters
 101 | WARNING | Line exceeds 80 characters; contains 115 characters
 119 | WARNING | Line exceeds 80 characters; contains 88 characters
 136 | WARNING | Line exceeds 80 characters; contains 90 characters
 138 | WARNING | Line exceeds 80 characters; contains 81 characters
--------------------------------------------------------------------------------


FILE: ...pal-issues/drupal-project/web/modules/contrib/synimport/synimport.info.yml
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 6 | WARNING | All dependencies must be prefixed with the project name, for
   |         | example "drupal:"
--------------------------------------------------------------------------------


FILE: .../drupal-project/web/modules/contrib/synimport/src/Service/Import/Files.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------
  91 | WARNING | Unused variable $tmp.
 139 | WARNING | Unused variable $tmp.
--------------------------------------------------------------------------------


FILE: ...-project/web/modules/contrib/synimport/src/Service/Import/CreateEntity.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first
   |       |     wrong one is Drupal\Core\Entity\EntityStorageInterface.
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Time: 858ms; Memory: 12MB

āžœ  contrib git:(main) āœ—
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024