Fix the issues reported by phpcs

Hi urvashi_vora,

I applied patch https://www.drupal.org/files/issues/2023-04-18/coding-standard-fixes_3.patch → to the "Parameters" module against Version 1.0.x-dev. and noticed that there are still phpcs issues reported

Please see the screenshots attached.

For your review.
Thank you.

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.

Providing patch with fixes.
please review.

-      $form_state->setError($form, $this->t('You don\'t have permission to manage this configuration.'));
+      $form_state->setError($form, $this->t("You don\'t have permission to manage this configuration."));

   public function validateForm(array &$form, FormStateInterface $form_state) {
     if (!$this->collection->access('update')) {
-      $form_state->setError($form, $this->t('You don\'t have permission to manage this configuration.'));
+      $form_state->setError($form, $this->t("You don\'t have permission to manage this configuration."));
     }

There is no need to escape the single-quote character, since that is not anymore the string delimiter.

-    $config['name'] = $form_state->getValue('name', $form_state->getValue(['config', 'parameter_name'], $config['name'] ?? ''));
+    $config['name'] = $form_state->getValue('name', $form_state->getValue([
+      'config',
+      'parameter_name',
+    ], $config['name'] ?? ''));

Code lines are allowed to exceed 80 characters, if they are more readable. I find the existing code more readable.

-    if (($form_state->getValue(['config', 'parameter_name'], '') !== '') && $form_state->getValue(['config', 'parameter_name']) !== $parameter_name) {
-      unset($parameters_array[$form_state->getValue(['config', 'parameter_name'], '')]);
+    if (($form_state->getValue([
+      'config', 'parameter_name',
+    ], '') !== '') && $form_state->getValue([
+      'config', 'parameter_name',
+    ]) !== $parameter_name) {
+      unset($parameters_array[$form_state->getValue([
+        'config',
+        'parameter_name',
+      ], '')]);
     }

Control structure conditions are allowed to exceed the 80 characters, if they are more readable. The existing code is more readable.

-   * return \Drupal\Core\StringTranslation\TranslatableMarkup[]
+   * Return \Drupal\Core\StringTranslation\TranslatableMarkup[]
    *   The options.
    */
   public static function options(): array {

return must be changed to @return, not Return.

+  /**
+   * {@inheritdoc}
+   */
   public function onOverrideSave($event) {
     $this->applyChanges($event, 'config_override_save');
   }
 
+  /**
+   * {@inheritdoc}
+   */
   public function onOverrideDelete($event) {
     $this->applyChanges($event, 'config_override_delete');
   }

+  /**
+   * {@inheritdoc}
+   */
   protected function applyChanges($event, string $op): void {

Those methods are not inherited from a parent class, nor defined in an interface. Their documentation comment cannot contain {@inheritdoc}.

-    [$provider, $type, $id] = array_merge(explode('.', $config_name, 3), ['', '']);
+    [$provider, $type, $id] = array_merge(explode('.', $config_name, 3), [
+      '',
+      '',
+    ]);

The existing code is more readable.

+ /**
+ * The UUID for this entity.
+ *
+ * @var string
+ */
+ protected $uuid;

Since that property is initialized with a \Drupal\Component\Uuid\UuidInterface instance, it is not an entity UUID nor can its type be string. The correct description is the same used for the constructor parameter.

+  /**
+   * Constructs a new block form.
+   *

The description for a constructor must start with Constructs a new followed by the class name (including its namespace), and end with object.
Also, since the class for that constructor is ParametersContentEntityNormalizer, which extends ContentEntityNormalizer, the constructor does not construct a new block form.

-   * return string[]
+   * Return string[]
    *   The contained parts.
    */

The tag to use for the return value type is @return.

-        $bundle_label = isset($info['label']) ? ($info['label'] instanceof TranslatableMarkup ? $info['label'] : new TranslatableMarkup((string) $info['label'])) : $bundle;
+        $bundle_label = $info['label'] ?? $bundle;

The changed code is not equivalent to the existing code. The existing code also checks $info['label'] is an instance of TranslatableMarkup.

-   * var \Drupal\Core\Lock\LockBackendInterface
+   * Var \Drupal\Core\Lock\LockBackendInterface.

That line must start with @var. The period at the end is not necessary.

       $values['pass'] = [[
         'value' => $entity->getPassword(),
         'pre_hashed' => TRUE,
-      ]];
+      ],
+      ];

The existing code is already correct.

   /**
    * Submit callback for elements of the user account form.
    *
-   * @param array &$element
-   *   The element being processed.
+   * @param array $form
+   *   The form array to add elements to.
    * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   The form state.
    */

Documentation comments for submission callbacks do not need to describe the parameters they get.

-        $this->logger->warning(t('Lock wait exceeded for endpoint @uri. Now trying to fetch data from it. This may cause more traffic than needed.', ['@url' => $uri]));
+        $this->logger->warning($this->t('Lock wait exceeded for endpoint @uri. Now trying to fetch data from it. This may cause more traffic than needed.', ['@url' => $uri]));
       }

Since that code is changed, the first argument passed to $this->logger->warning() must be changed too: It must be a literal string, not the value returned from $this->t().

-      $this->logger->error(t('Failed to read response body contents from @url. Exception message: @message',
+      $this->logger->error($this->t('Failed to read response body contents from @url. Exception message: @message',
         ['@url' => $uri, '@message' => $e->getMessage()]));

The same holds true for the first argument passed to $this->logger->error().

Thanks @apaderno for the suggestions, I've updated the MR, Please review the MR.
Thank you.

Hi @realsp,

Applied the plain diff of MR !5 latest version, it applied successfully, however multiple errors/warnings still persist.

parameters git:(1.0.x) curl https://git.drupalcode.org/project/parameters/-/merge_requests/5.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 43464    0 43464    0     0   109k      0 --:--:-- --:--:-- --:--:--  113k
patching file modules/parameters_ui/src/Controller/ParametersUiController.php
patching file modules/parameters_ui/src/Form/ParameterDeleteForm.php
patching file modules/parameters_ui/src/Form/ParameterForm.php
patching file modules/parameters_ui/src/Form/ParametersCollectionAddForm.php
patching file modules/parameters_ui/src/Form/ParametersCollectionForm.php
patching file modules/parameters_ui/src/Form/ParametersCollectionLockForm.php
patching file modules/parameters_ui/src/Form/ParametersCollectionUnlockForm.php
patching file modules/parameters_ui/src/ParametersUiListBuilder.php
patching file modules/parameters_ui/src/Routing/ParametersUiRouteEnhancer.php
patching file parameters.install
patching file src/Entity/ParametersCollectionStorage.php
patching file src/EventSubscriber/ParametersConfigOverrideSubscriber.php
patching file src/Exception/ParameterNotFoundException.php
patching file src/Internals/ContentSerializationCompilerPass.php
patching file src/Normalizer/ParametersContentEntityNormalizer.php
patching file src/ParameterRepository.php
patching file src/Plugin/Derivative/Parameter/ContentDeriver.php
patching file src/Plugin/Parameter/Bundles.php
patching file src/Plugin/Parameter/Content.php
patching file src/Plugin/Parameter/Fields.php
patching file src/Plugin/Parameter/Http.php
patching file src/Plugin/Parameter/Increment.php
patching file src/Plugin/Parameter/NullObject.php
patching file src/Plugin/Parameter/Roles.php
patching file src/Plugin/Parameter/Types.php
patching file src/Plugin/ParameterManager.php
patching file tests/src/Kernel/ParametersTokenTest.php
➜  parameters git:(1.0.x) ✗ cd ..
➜  contrib git:(main) ✗ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig parameters

FILE: ...odules/contrib/parameters/modules/parameters_ui/src/Form/ParameterForm.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
  21 | ERROR | [x] Use statements should be sorted alphabetically. The first
     |       |     wrong one is Drupal\Core\Session\AccountInterface.
 405 | ERROR | [ ] The array declaration extends to column 126 (the limit is
     |       |     120). The array content should be split up over multiple
     |       |     lines
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...l-orgissue/web/modules/contrib/parameters/src/Plugin/Parameter/Content.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AND 10 WARNINGS AFFECTING 12 LINES
--------------------------------------------------------------------------------
  186 | WARNING | [ ] Unused variable $bundle.
  189 | WARNING | [ ] Unused variable $bundle.
  357 | WARNING | [ ] Unused variable $cleanupFieldValues.
  358 | WARNING | [ ] Unused variable $normalizeNewEntities.
  363 | WARNING | [ ] Unused variable $cleanupFieldValues.
  364 | WARNING | [ ] Unused variable $normalizeNewEntities.
  381 | WARNING | [ ] Unused variable $cleanupFieldValues.
  382 | WARNING | [ ] Unused variable $normalizeNewEntities.
  387 | WARNING | [ ] Unused variable $cleanupFieldValues.
  388 | WARNING | [ ] Unused variable $normalizeNewEntities.
  561 | ERROR   | [x] Closing parenthesis of array declaration must be on a new
      |         |     line
 1232 | ERROR   | [x] Closing parenthesis of array declaration must be on a new
      |         |     line
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...rib/parameters/src/Normalizer/Legacy/ParametersContentEntityNormalizer.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 128 | ERROR | The array declaration extends to column 132 (the limit is 120).
     |       | The array content should be split up over multiple lines
--------------------------------------------------------------------------------

Time: 4.35 secs; Memory: 20MB

Kindly check

Thanks,
Jake