Fix the issues reported by PHPCS

Created on 13 April 2023, over 1 year ago
Updated 20 April 2023, over 1 year ago

Problem/Motivation

FILE: ...contribution/drupal10/web/modules/contrib/webform_better_results/README.md
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
--------------------------------------------------------------------------------
3 | WARNING | Line exceeds 80 characters; contains 84 characters
25 | WARNING | Line exceeds 80 characters; contains 84 characters
29 | WARNING | Line exceeds 80 characters; contains 81 characters
--------------------------------------------------------------------------------

FILE: .../contrib/webform_better_results/src/WebformSubmissionBetterListBuilder.php
--------------------------------------------------------------------------------
FOUND 11 ERRORS AND 4 WARNINGS AFFECTING 15 LINES
--------------------------------------------------------------------------------
5 | ERROR | [x] Non-namespaced classes/interfaces/traits should not be
| | referenced with use statements
7 | WARNING | [x] Unused use statement
8 | WARNING | [x] Unused use statement
10 | WARNING | [x] Unused use statement
22 | WARNING | [ ] Possible useless method overriding detected
36 | ERROR | [x] Data types in @return tags need to be fully namespaced
40 | ERROR | [x] Data types in @var tags need to be fully namespaced
48 | ERROR | [x] Data types in @var tags need to be fully namespaced
122 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
132 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
162 | ERROR | [x] Missing function doc comment
167 | ERROR | [x] Array indentation error, expected 8 spaces but found 10
168 | ERROR | [x] Array indentation error, expected 8 spaces but found 10
169 | ERROR | [x] Array indentation error, expected 8 spaces but found 10
170 | ERROR | [x] Array closing indentation error, expected 6 spaces but
| | found 8
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 14 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...0/web/modules/contrib/webform_better_results/webform_better_results.module
--------------------------------------------------------------------------------
FOUND 18 ERRORS AND 5 WARNINGS AFFECTING 19 LINES
--------------------------------------------------------------------------------
1 | ERROR | [x] Missing file doc comment
7 | WARNING | [x] Unused use statement
20 | ERROR | [x] Missing function doc comment
23 | WARNING | [ ] Line exceeds 80 characters; contains 85 characters
23 | ERROR | [x] Comments may not appear after statements
30 | ERROR | [x] Data types in @var tags need to be fully namespaced
30 | ERROR | [x] Data types in @var tags need to be fully namespaced
41 | ERROR | [x] Doc comment short description must end with a full stop
43 | ERROR | [ ] Missing parameter comment
44 | ERROR | [ ] Missing parameter comment
44 | ERROR | [x] Data types in @param tags need to be fully namespaced
45 | ERROR | [ ] Missing parameter comment
63 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
77 | WARNING | [ ] Only string literals should be passed to t() where
| | possible
104 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
118 | ERROR | [x] Doc comment short description must end with a full stop
120 | ERROR | [ ] Missing parameter comment
121 | ERROR | [ ] Missing parameter comment
121 | ERROR | [x] Data types in @param tags need to be fully namespaced
127 | WARNING | [ ] Line exceeds 80 characters; contains 83 characters
138 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
160 | 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."
186 | ERROR | [x] Expected 1 newline at end of file; 0 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 14 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Time: 455ms; Memory: 10MB

Steps to reproduce

Execute the command: phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,js,info,txt,md,yml,twig webform_better_results/

Proposed resolution

Resolve all the errors and warnings for Drupal and DrupalPractice Standards

Remaining tasks

Review the patch and fix the following:
FILE: .../contrib/webform_better_results/src/WebformSubmissionBetterListBuilder.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
18 | WARNING | Possible useless method overriding detected
--------------------------------------------------------------------------------

Time: 456ms; Memory: 10MB

📌 Task
Status

RTBC

Version

1.0

Component

Code

Created by

🇮🇳India urvashi_vora Madhya Pradesh, India

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

  • Issue created by @urvashi_vora
  • 🇵🇭Philippines kenyoOwen

    Hi urvashi_vora

    I applied the patch to the “Webform Better Results” module against Version 1.0.x-dev and there is 1 warning left. Please see the screenshots attached.

    For your review.
    Thank you.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Akram Khan Cuttack, Odisha

    added updated patch now it remove all the remaining issue

  • Status changed to RTBC over 1 year ago
  • 🇵🇭Philippines kenyoOwen

    Hi Akram Khan

    I applied the patch #3 to the “Webform Better Results” module against Version 1.0.x-dev and confirmed it removes the warning left. Please see the screenshots attached.

    For your review.
    Thank you.

Production build 0.71.5 2024