Contrib.social

Static code analysis

Open on Drupal.org →
Created on 27 December 2024, 4 months ago

Problem/Motivation

A common code style and most of the coding oversights can be handled via static code analysis. The standard tools here are PHPStan and PHPCS. Also a carefully configured Drupal code style validation can be automated by PHPCS.

I suggest to not apply the Drupal coding standard entirely. Below I have linked the PHPCS configuration for the Permissions by Term module, where the Drupal coding standard validation is configured by using excludes. For example class method attribute names can be immediately identified by a good name instead of the need to describe each of the attributes via sentences. Comments can become orphaned over time, like it's described in the clean code book from Robert Martin.

A benefit here is, that we do not need to write tests explicitly for ditching many possible issues. This does not mean, that the Slots module would not benefit from explicitly written (good) tests.

Proposed resolution

  • Configure PHPCS and PHPStan for the Slots module
  • Run the validation via GitLab CI by including the GitLab templates from the Drupal community

I did this already for the Permissions by Term Drupal module. This possibly could be a good reference. E.g.:
GitLab CI config
PHPCS config
PHPStan config (the level could be much higher here)

✨ Feature request
Status

Active

Version

1.0

Component

Code

Created by

🇩🇪Germany Peter Majmesku 🇩🇪Düsseldorf

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

Merge Requests

Comments & Activities

  • Issue created by @Peter Majmesku
  • Comment 4 months ago →
    🇩🇪Germany Peter Majmesku 🇩🇪Düsseldorf
  • Comment 4 months ago →
    🇩🇪Germany Hydra

    +1 For that in general

    Working on a major UI update right now, will look into this afterwords.

  • Merge request !36Issue #3496183: Initial commit for the static code analysis → (Merged) created by Peter Majmesku
  • Pipeline finished with Failed
    4 months ago
    Total: 120s
    #381192
  • Pipeline finished with Success
    4 months ago
    #381197
  • Pipeline finished with Success
    4 months ago
    Total: 163s
    #381268
  • Pipeline finished with Success
    4 months ago
    Total: 246s
    #381270
  • Pipeline finished with Success
    4 months ago
    Total: 201s
    #381275
  • Pipeline finished with Success
    4 months ago
    Total: 219s
    #381279
  • Pipeline finished with Success
    4 months ago
    Total: 202s
    #381288
  • Pipeline finished with Success
    4 months ago
    #381295
  • Pipeline finished with Success
    4 months ago
    Total: 160s
    #381301
  • Pipeline finished with Success
    4 months ago
    #381313
  • Pipeline finished with Success
    4 months ago
    Total: 161s
    #381319
  • Pipeline finished with Success
    4 months ago
    Total: 151s
    #381339
  • Pipeline finished with Success
    4 months ago
    Total: 153s
    #381343
  • Pipeline finished with Success
    4 months ago
    Total: 152s
    #381350
  • Comment 4 months ago →
    🇩🇪Germany Peter Majmesku 🇩🇪Düsseldorf

    I've implemented the GitLab CI pipeline configuration. It handles the static code analysis via PHP_CodeSniffer and PHPStan. This required some code and documentation changes to comply with the standards. All pipelines now pass. The code validation jobs are allowed to fail; this is the default behavior. I recommend always making sure that the jobs succeed. This essentially eliminates all syntax, spelling, and coding standard violations. Please review.

  • Comment 4 months ago →
    🇩🇪Germany Hydra

    @peter majmesku Hey thx for the work! Appreciated! I'd like to take a deeper look into this next week with my team

  • Pipeline finished with Success
    4 months ago
    Total: 199s
    #391837
  • Pipeline finished with Success
    4 months ago
    Total: 177s
    #391861
  • Comment 4 months ago →
    🇩🇪Germany Peter Majmesku 🇩🇪Düsseldorf

    @hydra: Merged in the current 1.x branch and made the pipelines pass. Please review.

  • Pipeline finished with Skipped
    4 months ago
    #392423
  • Comment 4 months ago →
    System Message
  • Comment 4 months ago →
    🇩🇪Germany Hydra

    Hey @peter majmesku! Thx for the work on this. This is a great starting point that will help us continually improving the module, really appreciated!

  • Comment 3 months ago →
    System Message

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

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024