Coding standards and best practices

Created on 1 February 2023, almost 2 years ago

The module has some coding standards and best practices issues.

🐛 Bug report
Status

Active

Version

4.0

Component

Code

Created by

🇮🇳India Raghavendra A M

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @Raghavendra A M
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India Raghavendra A M

    Hi, Uploading a patch for the fix.

  • 🇮🇳India riddhi.addweb

    I am trying to apply the "coding-standards-and-3338199-2.patch" but there is an error in the patch.
    Please check the Screenshot for the same.

  • Status changed to Needs work 4 months ago
  • First commit to issue fork.
  • Status changed to Needs review 4 months ago
  • Status changed to RTBC 4 months ago
  • 🇮🇳India riddhi.addweb

    I have applied the MR !50 cleanly and it resolves all the issues.
    Please check the screenshot for the same.

  • First commit to issue fork.
  • Pipeline finished with Success
    about 1 month ago
    Total: 138s
    #311994
  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸
  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

    This Merge Request appears to resolve all of the PHPCS errors. https://git.drupalcode.org/issue/environment_indicator-3338199/-/jobs/30...

  • Pipeline finished with Success
    about 1 month ago
    Total: 258s
    #312002
  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

    I've updated the fork to include upstream changes, most importantly, the gitlab ci config file.

    Additionally, I've configured gitlab CI to block merging if PHPCS tests fail in the future as to not allow merging any code that doesn't comply with Drupal coding standards in the future.

    See
    https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-dr...

  • 🇳🇱Netherlands tess bakker

    Looks good!

  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

    FYI, this merge request updates CSS, which is not covered by PHPCS, so I'll remove those changes here so that we can fix the CSS in a separate MR.

  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸
  • Pipeline finished with Success
    29 days ago
    #318746
  • 🇮🇳India riddhi.addweb

    I tried to apply the MR and it applied cleanly, but seems like still the PHPcs issues are not resolved. Attaching SS for the same.

  • 🇳🇱Netherlands tess bakker

    @riddhi.addweb This issue is about PHP Code style issues. Yes it can check CSS and JS, but there should be a new issue to enable StyleLint.

  • 🇳🇱Netherlands tess bakker

    Sorry forgot to add the validation report:

    $ ddev phpcs -v
    Registering sniffs in the drupal-project standard... DONE (126 sniffs registered)
    Creating file list... DONE (10 files in queue)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/src
    Processing EnvironmentIndicatorForm.php [PHP => 602 tokens in 81 lines]... DONE in 19ms (0 errors, 0 warnings)
    Processing EnvironmentIndicatorPermissions.php [PHP => 273 tokens in 47 lines]... DONE in 3ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/src/Entity
    Processing EnvironmentIndicator.php [PHP => 1028 tokens in 206 lines]... DONE in 11ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/src/Form
    Processing EnvironmentIndicatorSettingsForm.php [PHP => 491 tokens in 65 lines]... DONE in 6ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/src
    Processing ToolbarHandler.php [PHP => 2225 tokens in 333 lines]... DONE in 28ms (0 errors, 0 warnings)
    Processing EnvironmentIndicatorListBuilder.php [PHP => 489 tokens in 67 lines]... DONE in 6ms (0 errors, 0 warnings)
    Processing EnvironmentIndicatorAccessControlHandler.php [PHP => 198 tokens in 31 lines]... DONE in 3ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/src/Element
    Processing EnvironmentIndicator.php [PHP => 172 tokens in 35 lines]... DONE in 2ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator
    Processing environment_indicator.module [PHP => 2047 tokens in 253 lines]... DONE in 21ms (0 errors, 0 warnings)
    Changing into directory /var/www/html/web/modules/custom/environment_indicator/modules/environment_indicator_ui/src/Form
    Processing EnvironmentIndicatorUISettingsForm.php [PHP => 650 tokens in 85 lines]... DONE in 7ms (0 errors, 0 warnings)
    
    PHP CODE SNIFFER REPORT SUMMARY
    ------------------------------------------------------------------------------------------------------------------------------------------------------------
    FILE                                                                                                                                        ERRORS  WARNINGS
    ------------------------------------------------------------------------------------------------------------------------------------------------------------
    /var/www/html/web/modules/custom/environment_indicator/environment_indicator.module                                                         0       0
    /var/www/html/web/modules/custom/environment_indicator/modules/environment_indicator_ui/src/Form/EnvironmentIndicatorUISettingsForm.php     0       0
    /var/www/html/web/modules/custom/environment_indicator/src/EnvironmentIndicatorAccessControlHandler.php                                     0       0
    /var/www/html/web/modules/custom/environment_indicator/src/EnvironmentIndicatorForm.php                                                     0       0
    /var/www/html/web/modules/custom/environment_indicator/src/EnvironmentIndicatorListBuilder.php                                              0       0
    /var/www/html/web/modules/custom/environment_indicator/src/EnvironmentIndicatorPermissions.php                                              0       0
    /var/www/html/web/modules/custom/environment_indicator/src/ToolbarHandler.php                                                               0       0
    /var/www/html/web/modules/custom/environment_indicator/src/Element/EnvironmentIndicator.php                                                 0       0
    /var/www/html/web/modules/custom/environment_indicator/src/Entity/EnvironmentIndicator.php                                                  0       0
    /var/www/html/web/modules/custom/environment_indicator/src/Form/EnvironmentIndicatorSettingsForm.php                                        0       0
    ------------------------------------------------------------------------------------------------------------------------------------------------------------
    A TOTAL OF 0 ERRORS AND 0 WARNINGS WERE FOUND IN 10 FILES
    ------------------------------------------------------------------------------------------------------------------------------------------------------------
    
    Time: 175ms; Memory: 6MB
    
  • 🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

    @riddhi.addweb thanks for testing locally.

    This merge request is simply aiming to make the checkmark next to phpcs green with out any additional changes (which it does).

    https://git.drupalcode.org/issue/environment_indicator-3338199/-/pipelin...

Production build 0.71.5 2024