Coding Standard

Created on 28 December 2022, about 2 years ago
Updated 12 April 2023, over 1 year ago

Problem/Motivation

Coding Standard fix

Steps to reproduce

Run phpcs command

FILE: ...l-dir/web/modules/contrib/auto_node_translate/src/Form/TranslationForm.php
--------------------------------------------------------------------------------
FOUND 12 ERRORS AFFECTING 8 LINES
--------------------------------------------------------------------------------
165 | ERROR | [x] Expected 1 space after IF keyword; 0 found
192 | ERROR | [ ] Parameter $fieldType is not described in comment
192 | ERROR | [ ] Parameter $api is not described in comment
192 | ERROR | [ ] Parameter $languageFrom is not described in comment
195 | ERROR | [ ] Missing parameter type
222 | ERROR | [ ] Parameter $api is not described in comment
222 | ERROR | [ ] Parameter $languageFrom is not described in comment
225 | ERROR | [ ] Missing parameter type
233 | ERROR | [x] Expected 1 space after IF keyword; 0 found
242 | ERROR | [ ] Parameter $api is not described in comment
242 | ERROR | [ ] Parameter $languageFrom is not described in comment
245 | ERROR | [ ] Missing parameter type
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...nstall-dir/web/modules/contrib/auto_node_translate/src/Form/ConfigForm.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
101 | ERROR | [x] Functions must not contain multiple empty lines in a row;
| | found 2 empty lines
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...all-dir/web/modules/contrib/auto_node_translate/src/AmazonTranslateApi.php
--------------------------------------------------------------------------------
FOUND 5 ERRORS AND 3 WARNINGS AFFECTING 8 LINES
--------------------------------------------------------------------------------
5 | ERROR | [x] Whitespace found at end of line
36 | WARNING | [x] A comma should follow the last multiline array item. Found:
| | $secret
37 | WARNING | [x] A comma should follow the last multiline array item. Found:
| | ]
49 | ERROR | [x] Whitespace found at end of line
52 | ERROR | [x] Whitespace found at end of line
53 | WARNING | [x] A comma should follow the last multiline array item. Found:
| | $text
62 | ERROR | [x] Expected newline after closing brace
71 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 8 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...ir/web/modules/contrib/auto_node_translate/src/TranslationApiInterface.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------
7 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
10 | ERROR | Parameter $customTranslations is not described in comment
--------------------------------------------------------------------------------

FILE: ...b/modules/contrib/auto_node_translate/src/AutoNodeTranslatePermissions.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------
71 | ERROR | Description for the @return value is missing
75 | WARNING | Line exceeds 80 characters; contains 82 characters
--------------------------------------------------------------------------------

Proposed resolution

Need to fix coding standard

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

Fixed

Version

2.1

Component

Code

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024