- Issue created by @sidharth_soman
- š®š³India sidharth_soman Bangalore
Hi, I'm finding the following errors/warnings as detailed in the summary after running the php codesniffer command on the module. I'll work on fixing them.
- @sidharth_soman opened merge request.
- Issue was unassigned.
- Status changed to Needs review
almost 2 years ago 10:44am 11 April 2023 - š®š³India sidharth_soman Bangalore
I have fixed all the issues except for those relating to documentation and the names of the functions in the test file not being in camelCase format (which is quite minor and unnecessary). I have issued an MR for the same. Please review.
- Status changed to Needs work
8 months ago 7:09am 20 August 2024 - šµšPhilippines cleavinjosh
Hi @sidharth_soman,
I applied MR!2, it was applied smoothly and fixed most of the phpcs issues.
There are the remaining phpcs issues after I ran
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml:ā entity_browser_table git:(8.x-1.x) curl https://git.drupalcode.org/project/entity_browser_table/-/merge_requests/2.diff | patch -p1 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 16932 0 16932 0 0 50210 0 --:--:-- --:--:-- --:--:-- 50243 patching file css/entity_browser.table.css patching file src/Plugin/Field/FieldWidget/EntityReferenceBrowserTableWidget.php patching file tests/src/Kernel/EntityReferenceBrowserTableWidgetTests.php ā entity_browser_table git:(8.x-1.x) ā .. ā contrib phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,css,js,yml entity_browser_table FILE: /Users/interns/Demo-site/drupal-org-issues/web/modules/contrib/entity_browser_table/js/entity_browser.table.js -------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------------------------------------------- 68 | ERROR | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines -------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------------------------------------------- FILE: /Users/interns/Demo-site/drupal-org-issues/web/modules/contrib/entity_browser_table/tests/src/Kernel/EntityReferenceBrowserTableWidgetTests.php ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 63 ERRORS AND 1 WARNING AFFECTING 64 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 13 | ERROR | Doc comment is empty 18 | ERROR | Missing member variable doc comment 20 | ERROR | Missing member variable doc comment 22 | ERROR | Missing member variable doc comment 24 | ERROR | Missing member variable doc comment 26 | ERROR | Missing member variable doc comment 28 | ERROR | Missing member variable doc comment 30 | ERROR | Missing short description in doc comment 36 | ERROR | Missing member variable doc comment 50 | ERROR | Doc comment is empty 99 | ERROR | Doc comment is empty 102 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testBuildTableRows__GivenThreeEntities__ReturnArrayOfThree" is not in lowerCamel format 108 | ERROR | Doc comment is empty 111 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testBuildTableRows__GivenArrayOfFourStings__ReturnEmptyArray" is not in lowerCamel format 122 | ERROR | Doc comment is empty 131 | ERROR | Doc comment is empty 140 | ERROR | Doc comment is empty 149 | ERROR | Doc comment is empty 154 | WARNING | Line exceeds 80 characters; contains 94 characters 157 | ERROR | Doc comment is empty 160 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetEditButtonAccess__ReturnsTrue" is not in lowerCamel format 167 | ERROR | Doc comment is empty 170 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetEditButtonAccess__ReturnsFalse" is not in lowerCamel format 177 | ERROR | Doc comment is empty 180 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetReplaceButtonAccess__GivenOneEntityAndSettingTrue__ReturnTrue" is not in lowerCamel format 186 | ERROR | Doc comment is empty 189 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetReplaceButtonAccess__GivenOneEntityAndNoSetting__ReturnFalse" is not in lowerCamel format 194 | ERROR | Doc comment is empty 197 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetReplaceButtonAccess__GivenMultipleEntitiesAndSettingTrue__ReturnFalse" is not in lowerCamel format 202 | ERROR | Doc comment is empty 205 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetFirstColumn__GivenRenderedEntitySetting__ReturnMediaRenderArray" is not in lowerCamel format 218 | ERROR | Doc comment is empty 221 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetFirstColumn__GivenLabelSetting__ReturnMarkupRenderArray" is not in lowerCamel format 230 | ERROR | Doc comment is empty 233 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__GivenSetting__ReturnMarkup" is not in lowerCamel format 241 | ERROR | Doc comment is empty 244 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__GivenEmptySetting__ReturnNull" is not in lowerCamel format 250 | ERROR | Doc comment is empty 253 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__GivenNoSetting__ReturnNull" is not in lowerCamel format 258 | ERROR | Doc comment is empty 261 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetFirstColumnHeader__GivenRenderedEntitySetting__ReturnThumbnailString" is not in lowerCamel format 266 | ERROR | Doc comment is empty 269 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetFirstColumnHeader__GivenLabelSetting__ReturnTitleString" is not in lowerCamel format 274 | ERROR | Doc comment is empty 277 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetAdditionalFieldsHeader__GivenNoSettings__ReturnsNull" is not in lowerCamel format 281 | ERROR | Doc comment is empty 284 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetAdditionalFieldsHeader__GivenSetting__ReturnsMarkup" is not in lowerCamel format 289 | ERROR | Doc comment is empty 292 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetAdditionalFieldsHeader__GivenEmptySetting__ReturnsNull" is not in lowerCamel format 297 | ERROR | Doc comment is empty 300 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetActionColumnHeader__GivenDisplayEditButtonSetting__ReturnActionString" is not in lowerCamel format 305 | ERROR | Doc comment is empty 308 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetActionColumnHeader__GivenDisplayRemoveButtonSetting__ReturnActionString" is not in lowerCamel format 313 | ERROR | Doc comment is empty 316 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetActionColumnHeader__GivenDisplayReplaceButtonSetting__ReturnActionString" is not in lowerCamel format 321 | ERROR | Doc comment is empty 324 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testGetActionColumnHeader__GivenAllDisplayButtonSettingsFalse__ReturnNull" is not in lowerCamel format 332 | ERROR | Doc comment is empty 335 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__GivenEmptyOptionsList__ReturnEmptyArray" is not in lowerCamel format 341 | ERROR | Doc comment is empty 344 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__GivenOptionsStatus__ReturnArray" is not in lowerCamel format 350 | ERROR | Doc comment is empty 353 | ERROR | Public method name "EntityReferenceBrowserTableWidgetTests::testAdditionalFields__NoSetting__ReturnNull" is not in lowerCamel format 357 | ERROR | Doc comment is empty ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/interns/Demo-site/drupal-org-issues/web/modules/contrib/entity_browser_table/README.md --------------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES --------------------------------------------------------------------------------------------------- 21 | WARNING | Line exceeds 80 characters; contains 88 characters 30 | WARNING | Line exceeds 80 characters; contains 118 characters --------------------------------------------------------------------------------------------------- FILE: /Users/interns/Demo-site/drupal-org-issues/web/modules/contrib/entity_browser_table/src/Plugin/Field/FieldWidget/EntityReferenceBrowserTableWidget.php ------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 28 ERRORS AND 1 WARNING AFFECTING 28 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------ 37 | ERROR | [ ] Missing member variable doc comment 39 | ERROR | [ ] Missing member variable doc comment 41 | ERROR | [ ] Missing member variable doc comment 43 | ERROR | [ ] Missing member variable doc comment 45 | ERROR | [ ] Missing member variable doc comment 47 | ERROR | [ ] Missing member variable doc comment 49 | ERROR | [ ] Doc comment is empty 73 | ERROR | [ ] Doc comment is empty 89 | ERROR | [x] Multi-line function declarations must have a trailing comma after the last parameter 89 | ERROR | [x] The closing parenthesis of a multi-line function declaration must be on a new line 116 | ERROR | [ ] Doc comment is empty 138 | ERROR | [ ] Doc comment is empty 194 | ERROR | [ ] Doc comment is empty 211 | ERROR | [ ] Doc comment is empty 226 | WARNING | [ ] Unused variable $replace_button_access. 261 | ERROR | [ ] Doc comment is empty 271 | ERROR | [ ] Doc comment is empty 300 | ERROR | [ ] Doc comment is empty 323 | ERROR | [ ] Doc comment is empty 346 | ERROR | [ ] Doc comment is empty 360 | ERROR | [ ] Doc comment is empty 367 | ERROR | [ ] Missing short description in doc comment 381 | ERROR | [ ] Missing short description in doc comment 398 | ERROR | [ ] Doc comment is empty 407 | ERROR | [ ] Doc comment is empty 416 | ERROR | [ ] Doc comment is empty 425 | ERROR | [ ] Missing short description in doc comment 438 | ERROR | [ ] Missing short description in doc comment 439 | ERROR | [ ] Description for the @return value is missing ------------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------ Time: 329ms; Memory: 12MB ā contribThank you.