Fix the issues reported by phpcs

Created on 5 July 2023, 12 months ago

Updated 29 September 2023, 9 months ago

Problem/Motivation

FILE: /var/www/html/vb/d_cont/secure_admin_path/secure_admin_path.info.yml
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 1 LINE
--------------------------------------------------------------------------------
1 | WARNING | Remove "project" from the info file, it will be added by
| | drupal.org packaging automatically
1 | WARNING | Remove "datestamp" from the info file, it will be added by
| | drupal.org packaging automatically
1 | WARNING | Remove "version" from the info file, it will be added by
| | drupal.org packaging automatically
--------------------------------------------------------------------------------

FILE: /var/www/html/vb/d_cont/secure_admin_path/README.txt
----------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
----------------------------------------------------------------------
24 | WARNING | Line exceeds 80 characters; contains 136 characters
25 | WARNING | Line exceeds 80 characters; contains 109 characters
36 | WARNING | Line exceeds 80 characters; contains 375 characters
38 | WARNING | Line exceeds 80 characters; contains 468 characters
----------------------------------------------------------------------

FILE: /var/www/html/vb/d_cont/secure_admin_path/secure_admin_path.module
--------------------------------------------------------------------------------
FOUND 5 ERRORS AND 3 WARNINGS AFFECTING 4 LINES
--------------------------------------------------------------------------------
1 | ERROR | [x] Missing file doc comment
10 | WARNING | [ ] Hook implementations should not duplicate @param
| | documentation
10 | ERROR | [ ] Missing parameter comment
11 | WARNING | [ ] Hook implementations should not duplicate @param
| | documentation
11 | ERROR | [ ] Missing parameter comment
11 | ERROR | [x] Data types in @param tags need to be fully namespaced
13 | WARNING | [ ] Hook implementations should not duplicate @return
| | documentation
13 | ERROR | [ ] Description for the @return value is missing
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...www/html/vb/d_cont/secure_admin_path/src/Form/SecureAdminPathValidator.php
--------------------------------------------------------------------------------
FOUND 11 ERRORS AFFECTING 9 LINES
--------------------------------------------------------------------------------
7 | ERROR | [x] Missing class doc comment
11 | ERROR | [ ] Doc comment short description must be on a single line,
| | further text should be a separate paragraph
13 | ERROR | [ ] Missing parameter comment
15 | ERROR | [x] Expected "bool" but found "boolean" for function return type
15 | ERROR | [ ] Description for the @return value is missing
23 | ERROR | [x] Doc comment short description must end with a full stop
23 | ERROR | [ ] Doc comment short description must be on a single line,
| | further text should be a separate paragraph
25 | ERROR | [ ] Missing parameter comment
27 | ERROR | [ ] Description for the @return value is missing
34 | ERROR | [x] Expected 1 blank line after function; 0 found
35 | ERROR | [x] The closing brace for the class must have an empty line
| | before it
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Time: 171ms; Memory: 10MB

Steps to reproduce

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

Remaining tasks

Patch review

📌 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.

Comments & Activities

Issue created by @urvashi_vora
Comment 9 months ago →
Satish_kumar
hii@urvashi_vora
These are the steps I followed:

1. Took clone from git version 1.0.x in drupal 10.1.x

2. Ran this command:

./vendor/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig modules/contrib/secure_admin_path/

3. Applied your patch and, again ran phpcs command

found errors.

4. Create a patch and fixed the errors.

Please Review.
Status changed to RTBC 9 months ago11:55am 29 September 2023
Comment 9 months ago →
🇮🇳India aayushDrupal
Hi Satish_kumar,
Your patch has been successfully applied with no remaining errors. Please check the attached screenshot.

Moving to RTBC.
Thanks

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024