Drupal Coding Standards Issues | phpcs

Fixing the PHP coding standard issues, there is some issue left which we can ignore.

Charchil Khandelwal → made their first commit to this issue’s fork.

i will review this.

FILE: ...t\src\Plugin\Validation\Constraint\ParticipantInfoConstraint.php
----------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
18 | ERROR | Missing member variable doc comment
19 | ERROR | Missing member variable doc comment
20 | ERROR | Missing member variable doc comment
----------------------------------------------------------------------

There are some errors.

All the errors and warnings are fixed now.
Created MR !10 for this issue.
Please review.

Thank You.

This project uses core's standards to test coding coding standards - not the verbatim rules that come with coder.

You can run this by doing vendor/bin/phpcs -ps --standard="core/phpcs.xml.dist" modules/vgwort and it passes every rule so far adopted by core. We don't subscribe to the full Drupal coding standard for the following reasons:

1. +++ b/src/Api/AgencyParticipant.php
   @@ -12,11 +15,13 @@ class AgencyParticipant extends Participant {
      /**
   +   * Constructs a new AgencyParticipant.
   +   *
   

   Adding this type of documentation to a constructor adds nothing.

2. +++ b/src/Api/Participant.php
   @@ -21,12 +21,16 @@ abstract class Participant implements \JsonSerializable {
   -    if (!in_array($involvement, [static::AUTHOR, static::PUBLISHER, static::TRANSLATOR], TRUE)) {
   +    if (!in_array($involvement, [
   +      static::AUTHOR, static::PUBLISHER, static::TRANSLATOR,
   +    ], TRUE)) {
   

   The 80 char for arrays results in less readable code - and is under active discussion.

3. +++ b/src/Api/PersonParticipant.php
   @@ -31,11 +31,15 @@ class PersonParticipant extends Participant {
      /**
   +   * Participant identification code.
   +   *
       * @var \Drupal\vgwort\Api\IdentificationCode[]
       */
      private array $identificationCodes;
   

   This text adds nothing but duplication.

4. +++ b/src/ParticipantListManager.php
   @@ -20,7 +20,8 @@ use Drupal\vgwort\Api\Participant;
   - *   information about creating plugins, see the @link plugin_api Plugin API topic. @endlink
   + *   information about creating plugins, see the @link plugin_api Plugin API
   + *   topic. @endlink
   

   This standard is incorrectly implemented - when @link and @endlink are used you can go over 80 chars.

5. +++ b/tests/src/Kernel/ParticipantFieldTest.php
   @@ -9,6 +9,9 @@ namespace Drupal\Tests\vgwort\Kernel;
   +  /**
   +   * Validates the participant field.
   +   */
      public function testValidation() {
   

   Comments for test methods that repeat the method name are not useful.

Here's a patch with just the good changes from #7 and #2.

Committed #10

alexpott → closed merge request !10

Automatically closed - issue fixed for 2 weeks with no activity.