Contrib.social

Coding standards issue

Open on Drupal.org ā†’
Created on 6 December 2024, 5 months ago

Problem/Motivation

Steps to reproduce

FILE: ...decoupled_interface_translations/src/Controller/DecoupledInterfaceTranslationsController.php
--------------------------------------------------------------------------------------------------------------------------------------FOUND 41 ERRORS AND 3 WARNINGS AFFECTING 32 LINES
-------------------------------------------------------------------------------------------------------------------------------------- 1 | ERROR | [x] The PHP open tag must be followed by exactly one blank line
2 | ERROR | [x] Namespaced classes, interfaces and traits should not begin with a file doc comment
6 | ERROR | [x] There must be one blank line after the namespace declaration
17 | ERROR | [x] Doc comment short description must end with a full stop
18 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
19 | WARNING | [ ] The class short comment should describe what the class does and not simply repeat the class name
24 | ERROR | [ ] Missing short description in doc comment
25 | ERROR | [x] Data types in @var tags need to be fully namespaced
28 | ERROR | [ ] Missing short description in doc comment
29 | ERROR | [x] Data types in @var tags need to be fully namespaced
35 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
35 | ERROR | [ ] Missing parameter comment
35 | ERROR | [x] Data types in @param tags need to be fully namespaced
36 | ERROR | [ ] Missing parameter comment
36 | ERROR | [x] Data types in @param tags need to be fully namespaced
53 | ERROR | [ ] Missing short description in doc comment
54 | ERROR | [ ] Description for the @return value is missing
54 | ERROR | [x] Data types in @return tags need to be fully namespaced
57 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
60 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
62 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
65 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
68 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
69 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
70 | WARNING | [x] A comma should follow the last multiline array item. Found: DECOUPLED_STRING_CONTEXT
73 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
75 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
83 | ERROR | [ ] Missing short description in doc comment
84 | ERROR | [ ] Missing parameter comment
84 | ERROR | [x] Data types in @param tags need to be fully namespaced
85 | ERROR | [ ] Description for the @return value is missing
85 | ERROR | [x] Data types in @return tags need to be fully namespaced
94 | WARNING | [x] There must be no blank line following an inline comment
98 | ERROR | [x] Short array syntax must be used to define arrays
108 | ERROR | [x] Expected newline after closing brace
115 | ERROR | [ ] The array declaration extends to column 209 (the limit is 120). The array content should be split up over
| | multiple lines
115 | ERROR | [x] Expected 1 space between comma and "'created'"; 0 found
115 | ERROR | [x] Expected one space after the comma, 0 found
115 | ERROR | [x] Expected 1 space between "'created'" and double arrow; 0 found
115 | ERROR | [x] Expected 1 space between double arrow and "$created_source_strings"; 0 found
115 | ERROR | [x] Expected 1 space before "=>"; 0 found
115 | ERROR | [x] Expected 1 space after "=>"; 0 found
116 | ERROR | [x] Expected 1 blank line after function; 0 found
117 | ERROR | [x] The closing brace for the class must have an empty line before it
--------------------------------------------------------------------------------------------------------------------------------------PHPCBF CAN FIX THE 33 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------------------------------
Time: 155ms; Memory: 10MB

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

šŸ“Œ Task
Status

Active

Version

1.0

Component

Code

Created by

šŸ‡ØšŸ‡“Colombia kinyein

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

Merge Requests

Comments & Activities

  • Issue created by @kinyein
  • Merge request !4Coding standards fix ā†’ (Open) created by kinyein
  • Comment 5 months ago ā†’
    šŸ‡ØšŸ‡“Colombia kinyein

    Hi, I made a merge request to fix the coding standards issue in this module, I hope it can be reviewed soon

  • First commit to issue fork.
  • Comment 5 months ago ā†’
    šŸ‡µšŸ‡­Philippines clarkssquared

    Hi kinyein,

    I added a small commit in your MR because I its previous version there's this PHPCS issues

    āžœ  decoupled_interface_translations git:(1.0.x) curl https://git.drupalcode.org/project/decoupled_interface_translations/-/merge_requests/4.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  6667    0  6667    0     0  11764      0 --:--:-- --:--:-- --:--:-- 11926
patching file 'src/Controller/DecoupledInterfaceTranslationsController.php'
āžœ  decoupled_interface_translations git:(1.0.x) āœ— ..
āžœ  contrib git:(main) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml decoupled_interface_translations

FILE: ...e_translations/src/Controller/DecoupledInterfaceTranslationsController.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------
   8 | ERROR   | [x] Use statements should be sorted alphabetically. The first
     |         |     wrong one is Drupal\Core\Controller\ControllerBase.
 114 | WARNING | [ ] \Drupal calls should be avoided in classes, use dependency
     |         |     injection instead
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY

    Then I added a commit to fix the use statements order, the remaining PHPCS issue is \Drupal calls should be avoided in classes, use dependency injection instead and I will leave the decision to the maintainers if this issue should be fixed or not.

    Retaining the status to needs review.

  • Comment 5 months ago ā†’
    šŸ‡®šŸ‡³India akulsaxena

    Hi @clarkssquared
    The Gitlab considers Dependency injections to be a part of PHPStan testing and not PHPCS
    Since this issue is focused on coding standards and errors of codesniffer (PHPCS), the changes in the MR are good and solve them all.
    Another issue can be created for PHPStan errors while this one can be moved to RTBC and then merged

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024