Fix coding standards

Created on 17 February 2023, over 1 year ago
Updated 18 February 2023, over 1 year ago

Problem/Motivation

The module does not follow the Drupal Coding Standards.

FILE: .../web/modules/contrib/tvp/tvp.module
------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------
 18 | WARNING | Avoid backslash escaping in translatable strings when possible, use "" quotes instead
------------------------------------------------------------------------------------------------------


FILE: .../web/modules/contrib/tvp/README.txt
--------------------------------------------------------------------------
FOUND 1 ERROR AND 3 WARNINGS AFFECTING 4 LINES
--------------------------------------------------------------------------
 11 | WARNING | [ ] Line exceeds 80 characters; contains 95 characters
 12 | WARNING | [ ] Line exceeds 80 characters; contains 85 characters
 32 | WARNING | [ ] Line exceeds 80 characters; contains 83 characters
 33 | ERROR   | [x] Expected 1 newline at end of file; 2 found
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: .../web/modules/contrib/tvp/src/PathProcessor/TvpProcessor.php
-------------------------------------------------------------------------------------------------------------------------------------------
FOUND 74 ERRORS AFFECTING 44 LINES
-------------------------------------------------------------------------------------------------------------------------------------------
  21 | ERROR | [ ] Missing short description in doc comment
  26 | ERROR | [ ] Missing short description in doc comment
  27 | ERROR | [x] Data types in @var tags need to be fully namespaced
  32 | ERROR | [ ] Missing short description in doc comment
  33 | ERROR | [x] Data types in @var tags need to be fully namespaced
  47 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
  47 | ERROR | [ ] Missing parameter comment
  47 | ERROR | [x] Data types in @param tags need to be fully namespaced
  48 | ERROR | [ ] Missing parameter comment
  48 | ERROR | [x] Data types in @param tags need to be fully namespaced
  49 | ERROR | [ ] Missing parameter comment
  49 | ERROR | [x] Data types in @param tags need to be fully namespaced
  50 | ERROR | [ ] Missing parameter comment
  50 | ERROR | [x] Data types in @param tags need to be fully namespaced
  52 | ERROR | [x] Expected 1 blank line before function; 2 found
  61 | ERROR | [x] Expected 1 blank line after function; 0 found
  79 | ERROR | [ ] Missing short description in doc comment
  80 | ERROR | [ ] Missing parameter comment
  80 | ERROR | [ ] Missing parameter type
  81 | ERROR | [ ] Description for the @return value is missing
  84 | ERROR | [x] Expected 1 space after IF keyword; 0 found
  84 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
  89 | ERROR | [x] Expected one space after the comma, 0 found
  89 | ERROR | [x] Expected one space after the comma, 0 found
  89 | ERROR | [x] Expected one space after the comma, 0 found
  90 | ERROR | [x] Expected one space after the comma, 0 found
  90 | ERROR | [x] Concat operator must be surrounded by a single space
  90 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
  90 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
  94 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 107 | ERROR | [x] Doc comment short description must start with a capital letter
 107 | ERROR | [x] Doc comment short description must end with a full stop
 108 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
 108 | ERROR | [ ] Missing parameter comment
 108 | ERROR | [ ] Missing parameter type
 109 | ERROR | [ ] Missing parameter comment
 110 | ERROR | [x] Separate the @param and @return sections by a blank line.
 110 | ERROR | [ ] Description for the @return value is missing
 112 | ERROR | [ ] Type hint "array" missing for $options
 115 | ERROR | [x] Expected 1 space after IF keyword; 0 found
 115 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 115 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
 115 | ERROR | [x] There should be no white space before a closing ")"
 119 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 130 | ERROR | [ ] Missing short description in doc comment
 131 | ERROR | [ ] Missing parameter comment
 131 | ERROR | [ ] Missing parameter type
 132 | ERROR | [ ] Missing parameter comment
 132 | ERROR | [ ] Missing parameter type
 133 | ERROR | [ ] Missing parameter comment
 133 | ERROR | [ ] Missing parameter type
 134 | ERROR | [ ] Description for the @return value is missing
 138 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 145 | ERROR | [x] Doc comment short description must start with a capital letter
 145 | ERROR | [x] Doc comment short description must end with a full stop
 146 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
 146 | ERROR | [ ] Description for the @return value is missing
 149 | ERROR | [x] Opening brace should be on the same line as the declaration
 162 | ERROR | [ ] The array declaration extends to column 123 (the limit is 80). The array content should be split up over multiple lines
 166 | ERROR | [x] Inline comments must start with a capital letter
 166 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
 173 | ERROR | [x] Doc comment short description must start with a capital letter
 173 | ERROR | [x] Doc comment short description must end with a full stop
 174 | ERROR | [x] There must be exactly one blank line before the tags in a doc comment
 174 | ERROR | [ ] Description for the @return value is missing
 177 | ERROR | [x] Opening brace should be on the same line as the declaration
 183 | ERROR | [x] Use null coalesce operator instead of ternary operator.
 183 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
 184 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
 184 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
 187 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but found "null"
 187 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 194 | ERROR | [x] Expected 1 blank line after function; 0 found
 195 | ERROR | [x] The closing brace for the class must have an empty line before it
-------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 47 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------------------------

Steps to reproduce

Run phpcs

Proposed resolution

Fix the errors.

Remaining tasks

Create and review patch.

User interface changes

-

API changes

-

Data model changes

-

📌 Task
Status

Fixed

Version

1.0

Component

Code

Created by

🇧🇪Belgium tim-diels Belgium 🇧🇪

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

Comments & Activities

Production build 0.71.5 2024