Fix the issues reported by phpcs

Created on 1 April 2024, 8 months ago
Updated 18 September 2024, 2 months ago

Problem/Motivation

Here is the command : -
vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig modules/contrib/acquia_search/

FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/acquia_search.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
-------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/README.md
-----------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
-----------------------------------------------------------------------------
 52 | WARNING | Line exceeds 80 characters; contains 86 characters
 54 | WARNING | Line exceeds 80 characters; contains 93 characters
 64 | WARNING | Line exceeds 80 characters; contains 82 characters
-----------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/modules/acquia_search_defaults/acquia_search_defaults.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
----------------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Kernel/PreferredCoreServiceDeprecatedTest.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------
 9 | ERROR | Missing short description in doc comment
---------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Kernel/HookIndexLoadTest.php
----------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------
 11 | ERROR | Missing short description in doc comment
----------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/PreferredCoreServiceTest.php
---------------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
---------------------------------------------------------------------------------------------------------------
  29 | ERROR | [ ] Missing short description in doc comment
  36 | ERROR | [x] Missing function doc comment
  52 | ERROR | [x] Missing function doc comment
  67 | ERROR | [ ] Missing short description in doc comment
  92 | ERROR | [ ] Missing short description in doc comment
 117 | ERROR | [x] Missing function doc comment
 146 | ERROR | [ ] Missing short description in doc comment
 197 | ERROR | [x] Missing function doc comment
---------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/AcquiaSearchTestCase.php
-----------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-----------------------------------------------------------------------------------------------------------
 10 | ERROR | [x] Missing class doc comment
 12 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/EventSubscriber/PreQuery/EdisMaxTest.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
---------------------------------------------------------------------------------------------------------------------------
 17 | ERROR | Missing short description in doc comment
 23 | ERROR | Missing short description in doc comment
 48 | ERROR | Missing short description in doc comment
 84 | ERROR | Missing short description in doc comment
---------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/EventSubscriber/PossibleCores/DefaultCoreTest.php
------------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
------------------------------------------------------------------------------------------------------------------------------------
  14 | ERROR | [ ] Missing short description in doc comment
  20 | ERROR | [x] Missing function doc comment
  36 | ERROR | [x] Missing function doc comment
  57 | ERROR | [x] Missing function doc comment
  81 | ERROR | [ ] Missing short description in doc comment
 117 | ERROR | [x] Missing function doc comment
------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/EventSubscriber/PossibleCores/AcquiaHostingTest.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------------------------------------------------------------------
 15 | ERROR | [ ] Missing short description in doc comment
 21 | ERROR | [x] Missing function doc comment
 28 | ERROR | [x] Missing function doc comment
 33 | ERROR | [x] Missing function doc comment
 52 | ERROR | [ ] Missing short description in doc comment
 98 | ERROR | [x] Missing function doc comment
--------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/EventSubscriber/PossibleCores/LocalOverrideTest.php
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------------------------------------------------------------------
  15 | ERROR | [ ] Missing short description in doc comment
  21 | ERROR | [x] Missing function doc comment
  33 | ERROR | [ ] Missing short description in doc comment
  65 | ERROR | [x] Missing function doc comment
 130 | ERROR | [ ] Missing short description in doc comment
 157 | ERROR | [x] Missing function doc comment
--------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/HookRequirementsTest.php
-----------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
-----------------------------------------------------------------------------------------------------------
  26 | ERROR | [ ] Missing short description in doc comment
  31 | ERROR | [ ] Missing short description in doc comment
 106 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/AcquiaSearchServiceProviderTest.php
----------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------
 12 | ERROR | Missing short description in doc comment
----------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/AcquiaSearchApiClientTest.php
----------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------
 16 | ERROR | Missing short description in doc comment
----------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/SearchApiSolrAcquiaConnectorTest.php
-----------------------------------------------------------------------------------------------------------------------
FOUND 11 ERRORS AFFECTING 11 LINES
-----------------------------------------------------------------------------------------------------------------------
  57 | ERROR | [ ] Missing short description in doc comment
  63 | ERROR | [x] Missing function doc comment
  77 | ERROR | [x] Missing function doc comment
  94 | ERROR | [x] Missing function doc comment
 109 | ERROR | [x] Missing function doc comment
 119 | ERROR | [x] Missing function doc comment
 125 | ERROR | [x] Missing function doc comment
 140 | ERROR | [ ] Missing short description in doc comment
 154 | ERROR | [x] Missing function doc comment
 166 | ERROR | [x] Missing function doc comment
 182 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/drupal-contri-d10/modules/contrib/acquia_search/tests/src/Unit/FloodTest.php
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------
 13 | ERROR | Missing short description in doc comment
 19 | ERROR | Missing short description in doc comment
 43 | ERROR | Missing short description in doc comment
------------------------------------------------------------------------------------------------

Time: 1.33 secs; Memory: 14MB

Steps to reproduce

Run PHPCS on acquia_search module.

Proposed resolution

Fixed the coding standards

Remaining tasks

Submit the patch either MR .

📌 Task
Status

Closed: outdated

Version

3.1

Component

Code

Created by

🇮🇳India bhaveshdas

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

Merge Requests

Comments & Activities

Production build 0.71.5 2024