Fix Drupal Coding Standard issues

I have solved the fixable coding standard errors. However, there are many remaining which are to do with variable/method documentation comments. I think these would probably best be done by the maintainers. I'm moving this to 'Needs Review' for now but it's fine if someone else wants to work on the remaining errors too.

Please review this patch.

@_pratik_ already committed changes to this issue's fork, please provide your changes on top of his changes, @sidharth_soman!

Applying the patch #7 not remove all the standrad error till i m moving status to needs work.

The issue summary should always describe what the issue is trying to fix and, in the case, of coding standards issues, show which command has been used, which arguments have been used, and which report that command shown.

Patch #7 applied. #9 image not able to find complete pending issue list so attaching pending issues.

FILE: ~/projects/drupal-d10/modules/contrib/config_partial_export/src/Commands/ConfigPartialExportCommands.php
--------------------------------------
FOUND 51 ERRORS AND 2 WARNINGS AFFECTING 49 LINES
-----------------------------------------
  23 | ERROR   | Missing short description in doc comment
  28 | ERROR   | Missing member variable doc comment
  30 | ERROR   | Missing member variable doc comment
  32 | ERROR   | Missing member variable doc comment
  34 | ERROR   | Missing member variable doc comment
  36 | ERROR   | Missing member variable doc comment
  38 | ERROR   | Missing member variable doc comment
  40 | ERROR   | Missing member variable doc comment
  42 | ERROR   | Missing member variable doc comment
  44 | ERROR   | Missing short description in doc comment
  49 | ERROR   | Missing short description in doc comment
  50 | ERROR   | Missing parameter comment
  51 | ERROR   | Missing parameter comment
  52 | ERROR   | Missing parameter comment
  53 | ERROR   | Missing parameter comment
  54 | ERROR   | Missing parameter comment
  55 | ERROR   | Missing parameter comment
  56 | ERROR   | Missing parameter comment
  57 | ERROR   | Missing parameter comment
  58 | ERROR   | Missing parameter comment
  59 | ERROR   | Missing parameter comment
  78 | ERROR   | Missing parameter type
  80 | ERROR   | Missing parameter type
  81 | WARNING | Line exceeds 80 characters; contains 112 characters
  83 | WARNING | Line exceeds 80 characters; contains 88 characters
 163 | ERROR   | Parameter $destination_dir is not described in comment
 176 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_write_config" is not in lowerCamel format
 203 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_get_wildcard_keys" is not in lowerCamel format
 242 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_get_changes" is not in lowerCamel format
 265 | ERROR   | Missing short description in doc comment
 266 | ERROR   | Missing parameter comment
 267 | ERROR   | Description for the @return value is missing
 269 | ERROR   | Public method name "ConfigPartialExportCommands::_user_abort" is not in lowerCamel format
 269 | ERROR   | Type hint "null" missing for $msg
 275 | ERROR   | Missing short description in doc comment
 276 | ERROR   | Missing parameter comment
 276 | ERROR   | Missing parameter type
 277 | ERROR   | Missing parameter comment
 278 | ERROR   | Missing parameter comment
 279 | ERROR   | Missing parameter comment
 280 | ERROR   | Description for the @return value is missing
 282 | ERROR   | Public method name "ConfigPartialExportCommands::_choice" is not in lowerCamel format
 354 | ERROR   | Missing short description in doc comment
 355 | ERROR   | Missing parameter comment
 355 | ERROR   | Missing parameter type
 356 | ERROR   | Missing parameter comment
 357 | ERROR   | Missing parameter comment
 358 | ERROR   | Missing parameter comment
 359 | ERROR   | Description for the @return value is missing
 361 | ERROR   | Public method name "ConfigPartialExportCommands::_print_table" is not in lowerCamel format
 361 | ERROR   | Type hint "null" missing for $handle
 372 | ERROR   | Doc comment is empty
 375 | ERROR   | Public method name "ConfigPartialExportCommands::_drush_format_table" is not in lowerCamel format
---------------------------------------


FILE: ~/projects/drupal-d10/modules/contrib/config_partial_export/src/Utility/CommandHelper.php
-------------------------------------------------
FOUND 25 ERRORS AFFECTING 25 LINES
-----------------------------------------------
  22 | ERROR | Missing short description in doc comment
  27 | ERROR | Missing member variable doc comment
  29 | ERROR | Missing member variable doc comment
  31 | ERROR | Missing member variable doc comment
  33 | ERROR | Missing member variable doc comment
  35 | ERROR | Missing member variable doc comment
  37 | ERROR | Missing member variable doc comment
  39 | ERROR | Missing member variable doc comment
  41 | ERROR | Missing member variable doc comment
  43 | ERROR | Missing short description in doc comment
  48 | ERROR | Missing short description in doc comment
  49 | ERROR | Missing parameter comment
  50 | ERROR | Missing parameter comment
  51 | ERROR | Missing parameter comment
  52 | ERROR | Missing parameter comment
  53 | ERROR | Missing parameter comment
  54 | ERROR | Missing parameter comment
  55 | ERROR | Missing parameter comment
  56 | ERROR | Missing parameter comment
  57 | ERROR | Missing parameter comment
  58 | ERROR | Missing parameter comment
  74 | ERROR | Parameter $destination_dir is not described in comment
  87 | ERROR | Public method name "CommandHelper::_config_partial_export_write_config" is not in lowerCamel format
 114 | ERROR | Public method name "CommandHelper::_config_partial_export_get_wildcard_keys" is not in lowerCamel format
 153 | ERROR | Public method name "CommandHelper::_config_partial_export_get_changes" is not in lowerCamel format
------------------------------------------------------
Time: 196ms; Memory: 12MB

See comment #8 🐛 Fix the issues reported by phpcs Needs work : The patch needs to be re-rolled.

Remaining issues:

FILE: /home/system/Documents/contribution/config_partial_export-3336398/src/Utility/CommandHelper.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 1 WARNING AFFECTING 5 LINES
--------------------------------------------------------------------------------------------------------------------------
 130 | ERROR   | Parameter $destination_dir is not described in comment
 143 | ERROR   | Public method name "CommandHelper::_config_partial_export_write_config" is not in lowerCamel format
 170 | ERROR   | Public method name "CommandHelper::_config_partial_export_get_wildcard_keys" is not in lowerCamel format
 191 | WARNING | Line exceeds 80 characters; contains 81 characters
 208 | ERROR   | Public method name "CommandHelper::_config_partial_export_get_changes" is not in lowerCamel format
--------------------------------------------------------------------------------------------------------------------------


FILE: /home/system/Documents/contribution/config_partial_export-3336398/src/Commands/ConfigPartialExportCommands.php
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 2 WARNINGS AFFECTING 10 LINES
-----------------------------------------------------------------------------------------------------------------------------------------
 156 | ERROR   | The array declaration extends to column 142 (the limit is 80). The array content should be split up over multiple lines
 233 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_write_config" is not in lowerCamel format
 260 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_get_wildcard_keys" is not in lowerCamel format
 281 | WARNING | Line exceeds 80 characters; contains 81 characters
 298 | ERROR   | Public method name "ConfigPartialExportCommands::_config_partial_export_get_changes" is not in lowerCamel format
 330 | ERROR   | Public method name "ConfigPartialExportCommands::_user_abort" is not in lowerCamel format
 351 | ERROR   | Public method name "ConfigPartialExportCommands::_choice" is not in lowerCamel format
 354 | WARNING | Line exceeds 80 characters; contains 83 characters
 437 | ERROR   | Public method name "ConfigPartialExportCommands::_print_table" is not in lowerCamel format
 451 | ERROR   | Public method name "ConfigPartialExportCommands::_drush_format_table" is not in lowerCamel format
-----------------------------------------------------------------------------------------------------------------------------------------

Time: 107ms; Memory: 10MB

Fix the all reaming issues Please review and merge This Changes.

I have applied the !2 MR cleanly but still, getting some errors.
Please check the Screenshot.

FILE: /var/www/html/web/Drupal_9.5/web/modules/contrib/config_partial_export/src/Form/ConfigPartialExportForm.php
-----------------------------------------------------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 5 LINES
-----------------------------------------------------------------------------------------------------------------
 71 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 6
 72 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 6
 73 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 6
 74 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 6
 75 | ERROR | [x] Multi-line function declaration not indented correctly; expected 4 spaces but found 6
 75 | ERROR | [x] Multi-line function declarations must have a trailing comma after the last parameter
 75 | ERROR | [x] The closing parenthesis of a multi-line function declaration must be on a new line
-----------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 7 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/web/Drupal_9.5/web/modules/contrib/config_partial_export/src/Commands/ConfigPartialExportCommands.php
--------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------------------
 156 | ERROR | [x] The first parameter of a multi-line function declaration must be on the line after the opening bracket
 156 | ERROR | [x] Multi-line function declarations must define one parameter per line
 156 | ERROR | [x] Multi-line function declarations must define one parameter per line
 161 | ERROR | [x] Multi-line function declarations must have a trailing comma after the last parameter
 161 | ERROR | [x] The closing parenthesis of a multi-line function declaration must be on a new line
--------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------

Working on it.

I have updated the MR , kindly check.

Please check the MR.

I have applied the !2 MR cleanly but still, getting some errors.
Please check the Screenshot.

@riddhi.addweb please check again because there is no phpcs error in branch : 3336398-fix-drupal-coding and MR code also don't have any phpcs issue, have you checked my last commit ?

The 8.x-1.x branch is no longer supported.

Actually, there are no PHP_CodeSniffer errors/warnings, for the 2.x branch.