Fix the issues reported by phpcs

Hi

I fixed all the issues except Dependency injections

please review.

Hi dineshkumarbollu

I applied patch #2 to the “Micro Blogging” module and confirmed that the phpcs issue mentioned are resolved except for the Dependency injections. Needs work for others can fix the remaining issue. Please see the screenshots attached.

For your review.
Thank you.

-    _access: 'TRUE'
+    _access: true

The warning is: Open page callback found, please add a comment before the line why there is no access restriction. No comment has been added to explain why the access to that route is not restricted.

_access: 'TRUE' is correct and it is used by Drupal core too.

system.401:
  path: '/system/401'
  defaults:
    _controller: '\Drupal\system\Controller\Http4xxController:on401'
    _title: 'Unauthorized'
  requirements:
    _access: 'TRUE'

system.403:
  path: '/system/403'
  defaults:
    _controller: '\Drupal\system\Controller\Http4xxController:on403'
    _title: 'Access denied'
  requirements:
    _access: 'TRUE'

system.404:
  path: '/system/404'
  defaults:
    _controller: '\Drupal\system\Controller\Http4xxController:on404'
    _title: 'Page not found'
  requirements:
    _access: 'TRUE'

Addressed #5.
Providing patch with updated work

- * Class UpdateTimelineCommand
+ * Class UpdateTimelineCommand.

It is not necessary to report the class name in a class documentation comment.

+  /**
+   * Defines status.
+   *
+   * @var string
+   */
   protected $status;
-
+  /**
+   * Wrapper.
+   *
+   * @var int
+   */
   protected $wrapper;
-
+  /**
+   * Html variable.
+   *
+   * @var int
+   */
   protected $html;

Those descriptions are not much helpful and need to be improved.

+  /**
+   * {@inheritdoc}
+   */
   public function __construct($status, $wrapper, $html) {

{@inheritdoc} is not used in documentation comments for constructors.

 /**
- * Class TimelineController
+ * Defines TimelineController class.
  *
  * @package Drupal\microblogging\Controller

That description is still repeating the class name, instead of describing the class purpose.

+   * Route match service.
+   *
    * @var \Drupal\Core\Routing\RouteMatchInterface

A definite article is missing from the description.

   /**
+   * The user service.
+   *
    * @var \Drupal\user\UserInterface
    */
   protected $currentUser;

That is not a correct description, since $currentUser does not contain a service, but a specific entity instance.

   /**
+   * Renderer service.
+   *
    * @var \Drupal\Core\Render\Renderer

    * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
+   *   Route match object.
    * @param \Drupal\Core\Session\AccountProxyInterface $account
+   *   Account Proxy service.
    * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder
+   *   Form Builder service.
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
+   *   Entity type service.
    * @param \Drupal\Core\Render\Renderer $renderer
+   *   Renderer service.

A definite article is missing from each of those descriptions too.

    * @return array
+   *   Returns array.

The return value description must say what is returned not its type, which is already given with @return array.

-    // Load status
+    // Load status.
     $data = MicroBloggingHelper::getStatus($user->id());

That comment is not necessary, since it describes something that is already clear.

Addressed the issue in #7. Please review is that fine.

Hi @sakthi_dev, thanks for the patch, I have reviewed your patch.

These are the steps I followed:

1. Took clone from git version 1.0.x in drupal 10.1.x

2. Ran this command:

./vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig modules/contrib/microblogging

3. Applied patch and again ran phpcs command,

Found 1 white space error after applying patch.

Found errors after ran phpcs command.

4. I ran phpcbf to fix errors and created a patch and fixed the remaining errors,

then again check with phpcs command found no errors.

Attached patch file and screenshots.

Please Review.

Hi,

I have reviewed patch #10, looks good to me. It applied cleanly and fixed phpcs issues but still few of them are remaining that need to be fixed:

FILE: /microblogging/assets/js/timeline.js
------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------
  4 | ERROR | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines
  7 | ERROR | [x] Expected 1 space after FUNCTION keyword; 0 found
 22 | ERROR | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines
------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------


FILE: /microblogging/src/Ajax/UpdateTimelineCommand.php
---------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------
 42 | ERROR | Type hint "array" missing for $html
---------------------------------------------------------------------------------------------------------

Please fix these errors as well.

Thanks & Regards,
Mrinalini

Please review. Addressed the comment #11.

Reviewed patch #12, looks good to me. It applied cleanly and fixed all the phpcs issues.
So, for me, it is RTBC.

Thanks!

Hi,
I have reviewed patch #12, it looks good to me. It applied cleanly and fixed phpcs errors and warning.
So changing the status to RTBC.
Thankyou.