Contrib.social

Update code to follow Drupal best practices

Open on Drupal.org →
Created on 7 February 2023, about 2 years ago
Updated 31 March 2023, about 2 years ago

Problem/Motivation

Running coder, the following issues were found in amswap.module

------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 3 LINES
------------------------------------------------------------
 27 | ERROR   | The array declaration extends to column 108 (the limit is 80). The array content should be split up over multiple lines
 27 | ERROR   | The array declaration extends to column 107 (the limit is 80). The array content should be split up over multiple lines
 31 | WARNING | Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
    |         | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
 32 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
------------------------------------------------------------

Steps to reproduce

  1. Install Coder
  2. Run phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml on the amswap.module file

Proposed resolution

Fix the errors and warnings above.

🐛 Bug report
Status

Fixed

Version

3.2

Component

Code

Created by

🇺🇸United States cedewey Denver, CO

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Issue created by @cedewey
  • Comment about 2 years ago →
    🇨🇦Canada chrisck BC, Canada

    In addition to the amswap.module errors found, there are more errors found in /src/Render/Element/Amswap.php:

    ------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 7 LINES
------------------------------------------------------------
 42 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 50 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 67 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 74 | WARNING | [ ] Line exceeds 80 characters; contains 84 characters
 74 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 78 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 83 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 90 | ERROR   | [x] Expected 1 space after "="; 2 found
------------------------------------------------------------
  • Assigned to chrisck
  • Comment about 2 years ago →
    🇨🇦Canada chrisck BC, Canada
  • @chrisck opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review about 2 years ago
  • Comment about 2 years ago →
    🇨🇦Canada chrisck BC, Canada
  • Comment about 2 years ago →
    System Message
  • @chrisck opened merge request.
  • Comment about 2 years ago →
    🇨🇦Canada chrisck BC, Canada

    MR in #7 addresses all of the phpcs errors found.

  • Status changed to RTBC about 2 years ago
  • Comment about 2 years ago →
    🇺🇸United States cedewey Denver, CO

    I've tested this merge request and confirmed that all errors are resolved. Thanks chrisck!

  • Assigned to arunkumark
  • Status changed to Needs review about 2 years ago
  • Comment about 2 years ago →
    🇮🇳India arunkumark Coimbatore

    Reviewed the patch, and found minor issues related to the Coding standards.

    FILE: /var/www/html/web/modules/custom/amswap/src/Form/AmswapConfigForm.php
-----------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------
 17 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
-----------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/web/modules/custom/amswap/src/Render/Element/Amswap.php
---------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
---------------------------------------------------------------------------
 74 | WARNING | Line exceeds 80 characters; contains 85 characters
---------------------------------------------------------------------------

    Creating the fixes for resolve.

  • Issue was unassigned.
  • Comment about 2 years ago →
    🇮🇳India arunkumark Coimbatore

    Updated MR

  • Comment about 2 years ago →
    🇮🇳India arunkumark Coimbatore
  • Comment about 2 years ago →
    🇺🇸United States cedewey Denver, CO
  • Status changed to Fixed about 2 years ago
  • Comment about 2 years ago →
    🇺🇸United States cedewey Denver, CO

    I agree. Those warnings are minor and I actually think the way it is now is more readable than if we were to force characters to wrap earlier. Thanks everyone who helped out on this!

  • Comment almost 2 years ago →
    System Message

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

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024