Fix the issues reported by phpcs

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.

Issue summary updated.

Providing patch with fixes.
Please review.

Hi

The patch#6 applied cleanly with no phpcs errors.

Moving +RTBC

+/**
+ * @file
+ * Provide some extra functionality for module.
+ */

The usual description is Hook implementations for the [module name] module. (Indeed, [module name] must be replaced by the module name.)

+  /**
+   * The module handler service.
+   *
+   * @var \Drupal\Core\Extension\ModuleHandlerInterface
+   */

There is no need to say it is a service.

+  /**
+   * The cryptography service.
+   *
+   * @var \Drupal\Component\Utility\CryptoService
+   */
   protected CryptoService $cryptoService;

Drupal core does not have any \Drupal\Component\Utility\CryptoService class.

+  /**
+   * {@inheritdoc}
+   */
   public function __construct(string $root, ModuleHandlerInterface $moduleHandler, AccountInterface $currentUser, CsrfTokenGenerator $csrfToken, LoggerChannelInterface $logger, CryptoService $cryptoService) {

{@inheritdoc}

is not used for constructors.

+/**
+ * Class to providing functionality SessionlessFormsServiceProvider.
+ */

Class descriptions must not start with Class not repeat the class name.
That description does not make sense either.

+  /**
+   * The sticky query storage implementation used for storing sticky queries.
+   *
+   * @var \Drupal\sticky_query\StickyQueryStorage\StickyQueryStorageInterface
+   */
   protected StickyQueryStorageInterface $storage;

What is a sticky query storage?

 /**
- * Key Storage
+ * Key Storage.
  *
  * @internal
  *

The definite article is missing in the short description.

+  /**
+   * The key storage object for this class.
+   *
+   * @var \Drupal\Core\Encryption\CryptoKeyStorage
+   */
+  protected $keyStorage;

There is no need to say for this class: Every property is for the class that defines it.

-    /** @noinspection PhpUnnecessaryLocalVariableInspection */
+    /* @noinspection PhpUnnecessaryLocalVariableInspection */

That line is already correct as it is.

+  /**
+   * {@inheritdoc}
+   */
   protected static function getCryptoService(): CryptoService {

{@inheritdoc} cannot be used for traits that do not inherit from other traits.

Addressed phpcs issues.

+/**
+ * @file
+ * Sessionless Forms module for encrypting and signing form data.
+ */

The usual description is Hook implementations for the [module name] module. where [module name] is the module name shown in the .info.yml file.

+  /**
+   * The module handler service.
+   *
+   * @var \Drupal\Core\Extension\ModuleHandlerInterface
+   */

+  /**
+   * The CSRF token generator service.
+   *
+   * @var \Drupal\Core\Access\CsrfTokenGenerator
+   */
   protected CsrfTokenGenerator $csrfToken;
 
+  /**
+   * The logger channel service.
+   *
+   * @var \Drupal\Core\Logger\LoggerChannelInterface
+   */
   protected LoggerChannelInterface $logger;

There is no need to say service in the descriptions.

+  /**
+   * The CryptoService for handling encryption and signing.
+   *
+   * @var \Drupal\sessionless\CryptoService
+   */
   protected CryptoService $cryptoService;

The description must not include the class name.

+  /**
+   * Get cache.
+   *
+   * Retrieves the cached form data from encrypted fields.
+   *
+   * @param string $form_build_id
+   *   The form build ID.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The form state.
+   *
+   * @return mixed
+   *   The cached form.
+   */

The verb in the short description must be declined to the third person singular.
I am not sure the long description is correct, since the cached data is not retrieved from the encrypted fields. It is retrieved from the cache.

+  /**
+   * Delete cache.
+   *
+   * Deletes cached form data.
+   *
+   * @param string $form_build_id
+   *   The form build ID to identify the cached data.

There is no need to use short and long description, when the long description is an one-line description.

+/**
+ * Service provider for Sessionless Forms module.
+ */
 class SessionlessFormsServiceProvider extends ServiceProviderBase {
 

The description must not include the class name. It is also too generic.

+  /**
+   * The storage for session data.
+   *
+   * @var \Drupal\sticky_query\StickyQueryStorage\StickyQueryStorageInterface
+   */
   protected StickyQueryStorageInterface $storage;

It does not seem that is the session data storage.

+  /**
+   * SessionlessSession constructor.
+   *
+   * @param \Drupal\sticky_query\StickyQueryStorage\StickyQueryStorageInterface $storage
+   *   The storage for session data.
+   * @param bool $encrypt
+   *   (Optional) TRUE to encrypt session data, FALSE to skip encryption.
+   */
   public function __construct(StickyQueryStorageInterface $storage, bool $encrypt = TRUE) {

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

+  /**
+   * Start the session.
+   */
   public function start() {}
 
+  /**
+   * Get the session ID.
+   *
+   * @return string
+   *   The session ID.
+   */
   public function getId() {
     return 'sessionless';
   }
 
+  /**
+   * Set the session ID.
+   *
+   * @param string $id
+   *   The session ID.
+   */

The verb in the description must be declined to the third person singular.

I would also check which of those methods are defined in an interface, as in that case the documentation comments are different.

+   * @return \BadMethodCallException
+   *   An exception indicating the method is not allowed.

Thrown exceptions are documented with @throws, not @return.

 /**
- * Key Storage
+ * Key Storage.

Only the first word in the description is capitalized. A definite article is missing.

+  /**
+   * The state service for managing key storage.
+   *
+   * @var \Drupal\Core\State\StateInterface
+   */
   protected StateInterface $state;

The usual description of that service is The state key value store.

MR is updated.
Please review.

Hi @imustakim,

Your changes in MR!1 was applied not-so successfully, might be the reason the errors below were still reported. Please see:

sessionless git:(1.x) curl https://git.drupalcode.org/project/sessionless/-/merge_requests/1.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 20609    0 20609    0     0  49569      0 --:--:-- --:--:-- --:--:-- 51012
patching file sessionless_forms/sessionless_forms.module
Hunk #2 succeeded at 24 with fuzz 2 (offset 2 lines).
patching file sessionless_forms/src/SessionlessFormCache.php
patching file sessionless_forms/src/SessionlessFormsServiceProvider.php
patching file sessionless_session/sessionless_session.info.yml
patching file sessionless_session/src/SessionlessSession.php
Hunk #1 FAILED at 11.
1 out of 1 hunk FAILED -- saving rejects to file sessionless_session/src/SessionlessSession.php.rej
patching file sessionless_session/src/SessionlessStickyQueryFactory.php
patching file sessionless_session/src/StickyQueryStorageEncryptionDecorator.php
patching file src/CryptoKeyStorage.php
patching file src/CryptoService.php
patching file src/Element/SessionlessElementTrait.php
patching file src/Element/SignedEncryptedData.php
➜  sessionless git:(1.x) ✗ cd ..
➜  contrib git:(main) ✗ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig sessionless

FILE: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/sessionless/sessionless_session/src/SessionlessStickyQueryFactory.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------------------
 31 | WARNING | Line exceeds 80 characters; contains 87 characters
----------------------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/sessionless/sessionless_session/src/SessionlessSession.php
-----------------------------------------------------------------------------------------------------------------------------------
FOUND 25 ERRORS AFFECTING 25 LINES
-----------------------------------------------------------------------------------------------------------------------------------
  15 | ERROR | [ ] Missing member variable doc comment
  17 | ERROR | [ ] Missing member variable doc comment
  22 | ERROR | [x] Expected 1 blank line after function; 2 found
  25 | ERROR | [x] Missing function doc comment
  26 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
  29 | ERROR | [x] Missing function doc comment
  33 | ERROR | [x] Missing function doc comment
  35 | ERROR | [x] Missing function doc comment
  39 | ERROR | [x] Missing function doc comment
  41 | ERROR | [x] Missing function doc comment
  43 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
  46 | ERROR | [x] Missing function doc comment
  47 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
  50 | ERROR | [x] Missing function doc comment
  52 | ERROR | [x] Missing function doc comment
  57 | ERROR | [x] Missing function doc comment
  62 | ERROR | [x] Missing function doc comment
  68 | ERROR | [x] Missing function doc comment
  72 | ERROR | [x] Missing function doc comment
  78 | ERROR | [x] Missing function doc comment
  86 | ERROR | [x] Missing function doc comment
  90 | ERROR | [x] Missing function doc comment
  94 | ERROR | [x] Missing function doc comment
  98 | ERROR | [x] Missing function doc comment
 102 | ERROR | [x] Missing function doc comment
-----------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 23 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/sessionless/sessionless_session/src/StickyQueryStorageEncryptionDecorator.php
------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------------
 35 | WARNING | Line exceeds 80 characters; contains 95 characters
------------------------------------------------------------------------------------------------------------------------------------------------------

Time: 282ms; Memory: 10MB

Kindly check

Thanks,
Jake

apaderno → changed the visibility of the branch 3295666-fix-the-issues to hidden.

apaderno → changed the visibility of the branch 3295666-gitlab-ci-reports to hidden.