- Issue created by @urvashi_vora
- Status changed to Needs work
over 1 year ago 11:46am 13 June 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
/** + * Get the result from a handled message envelope. + * * @param \Symfony\Component\Messenger\Envelope $envelope + * The message envelope. * * @return mixed + * The result from handling the message.
The verb used in the description must be declined to the third person singular.
The result from handling the message. is a bit too broad. The description should say exactly what is returned, especially when there are values returned in case of errors.
- Status changed to Needs review
over 1 year ago 12:44pm 14 June 2023 - ๐ฎ๐ณIndia Ashutosh Ahirwal India
Fixes the issue providing patch.
Please review. - Status changed to Needs work
over 1 year ago 5:12pm 14 June 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
-Messenger must be downloaded with Composer, and can be installed like any other Drupal module. +Messenger must be downloaded with Composer, +and can be installed like any other Drupal module.
That line has been split too early, given that without exceeding 80 characters, the first line would be Messenger must be downloaded with Composer, and can be installed like any.
/** - * + * Class to provide functionality for MessengerDataCollector.
Saying that a class provides functionality for itself is not an helpful description, and it is also wrong since a class provides functionality to every class and function that uses it.
/** - * + * A trait to provides method to extract the result from Symfony Messenger. */ trait ResponseTrait {
That description is quite vague too.
+ * Retrieves the result from a Symfony Messenger envelope. + * * @param \Symfony\Component\Messenger\Envelope $envelope + * The envelope containing the message result. * * @return mixed + * The result of the message handling.
The result of the message handling. is not quiet different from The result from handling the message. If the latter is a bit too vague, the first is a bit too vague too. At least, it should say what exactly is returned.
- Assigned to nitin_lama
- Issue was unassigned.
- Status changed to Needs review
over 1 year ago 9:40am 15 June 2023 - Status changed to Needs work
5 months ago 7:51am 19 July 2024 Hi @nitin_lama,
I applied the patch you provided, it was applied not-so successfully, might be the reason multiple errors were reported. Please see below:
symfony_messenger git:(1.0.x) โ curl https://www.drupal.org/files/issues/2023-06-15/phpcs-issue-fixes-3366413-6.patch | patch -p1 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 3097 100 3097 0 0 14106 0 --:--:-- --:--:-- --:--:-- 14818 patching file README.md Reversed (or previously applied) patch detected! Assume -R? [n] n Apply anyway? [n] n Skipping patch. 1 out of 1 hunk ignored -- saving rejects to file README.md.rej patching file src/DataCollector/MessengerDataCollector.php Hunk #1 FAILED at 6. 1 out of 1 hunk FAILED -- saving rejects to file src/DataCollector/MessengerDataCollector.php.rej patching file src/ResponseTrait.php Hunk #1 FAILED at 8. 1 out of 1 hunk FAILED -- saving rejects to file src/ResponseTrait.php.rej patching file symfony_messenger_example/src/Controller/ExampleController.php Hunk #1 succeeded at 9 (offset 2 lines). โ symfony_messenger git:(1.0.x) โ cd .. โ contrib git:(master) โ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig symfony_messenger FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestMethod2Message.php ------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 2 ERRORS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. 7 | ERROR | [ ] Missing short description in doc comment ------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestClassMessage.php ----------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 2 ERRORS AFFECTING 2 LINES ----------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. 7 | ERROR | [ ] Missing short description in doc comment ----------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ----------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestMethodMessage.php ------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 2 ERRORS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. 7 | ERROR | [ ] Missing short description in doc comment ------------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestSubdirMessage.php ------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 2 ERRORS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. 7 | ERROR | [ ] Missing short description in doc comment ------------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/Messenger/Subdir/TestMessageSubdirHandler.php ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/Messenger/TestMessageMethodHandler.php ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/Messenger/TestMessageClassHandler.php ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestServiceMessage.php ------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 2 ERRORS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. 7 | ERROR | [ ] Missing short description in doc comment ------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/modules/symfony_messenger_test/src/TestMessageServiceHandler.php -------------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. -------------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/tests/src/Kernel/SymfonyMessengerMessageHandlerTest.php ----------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ----------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ----------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ----------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/symfony_messenger_example/src/Controller/ExampleController.php ------------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/symfony_messenger_example/src/Command/ExampleRequest.php ------------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/symfony_messenger_example/src/Command/ExampleResponse.php ------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/symfony_messenger_example/src/Command/ExampleRequestHandler.php ------------------------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/DataCollector/MessengerDataCollector.php ------------------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/Middleware/LogResponseMiddleware.php -------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE -------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. -------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/HandlerResponseInterface.php ------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/ResponseTrait.php ------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------- FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/SymfonyMessengerMessageHandlerCompilerPass.php ------------------------------------------------------------------------------------------------------------------------------------------------ FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------------------ 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------------------ FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/symfony_messenger/src/SymfonyMessengerServiceProvider.php ------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------- 3 | ERROR | [x] Expected strict_types=1, found strict_types = 1. ------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------------- Time: 267ms; Memory: 10MB
Kindly check
Thanks,
Jake- ๐ฎ๐ณIndia dev2.addweb
nilesh.addweb โ made their first commit to this issueโs fork.
- Merge request !11Created a new issue fork to get the list of PHP_CodeSniffer errors/warnings to fix โ (Open) created by apaderno
- Status changed to Needs review
5 months ago 8:35am 19 July 2024 - ๐ฎ๐ณIndia dev2.addweb
Hi @a.aaronjake
I have fixed all the mentioned errors and warnings and also raised MR for the same. Kindly check.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
apaderno โ changed the visibility of the branch 3366413-gitlab-ci-reports to hidden.
- Status changed to RTBC
5 months ago 8:41am 19 July 2024 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น