Fix the issues reported by phpcs [#3338149]

Problem/Motivation

Getting the following phpcs errors/warnings:

FILE: tests/src/Functional/ColorFieldFormatterTest.php
-----------------------------------------------
FOUND 0 ERRORS AND 8 WARNINGS AFFECTING 8 LINES
------------------------------------------------
  49 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
  69 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
  88 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 107 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 136 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 156 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 186 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 208 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
------------------------------------------------


FILE: tests/src/Functional/ColorFieldWidgetTest.php
------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------
 43 | WARNING | t() calls should be avoided in classes, use
    |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
------------------------------------------------


FILE: tests/src/Functional/ColorFieldFormatterTokenTest.php
------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
------------------------------------------------
 55 | WARNING | t() calls should be avoided in classes, use
    |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 94 | WARNING | t() calls should be avoided in classes, use
    |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
------------------------------------------------


FILE: src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php
------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
------------------------------------------------
 155 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
 162 | WARNING | t() calls should be avoided in classes, use
     |         | \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead
------------------------------------------------

Steps to reproduce

Run the following command from the module folder:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml .

Proposed resolution

Fix the errors and warnings.

Comment	File	Size	Author
#10	after patch.png	109.12 KB	paraderojether
#10	before patch.png	279.9 KB	paraderojether
#4	3338149-4.patch	8.03 KB	adil_siddiqui
#3	color_field_patch_on_3.0.x.png	291.15 KB	arisen
#2	3338149-2.patch	7.04 KB	mrinalini9

Issue fork color_field-3338149

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3338149-gitlab-ci-reports changes, plain diff MR !31
Check out this branch for the first time

Check out existing branch, if you already have it locally
3338149-fix-phpcs-issue changes, plain diff MR !22
Check out this branch for the first time

Check out existing branch, if you already have it locally

2 hidden branches

3.0.x

compare

Check out this branch for the first time

Check out existing branch, if you already have it locally

3338149-fix-the-issues

changes, plain diff MR !13

Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

1 February 2023 at 07:38

mrinalini9 created an issue. See original summary.

Comment #2

mrinalini9 commented 1 February 2023 at 07:42

Assigned:	mrinalini9	» Unassigned
Status:	Active	» Needs review

Status	File	Size
new	3338149-2.patch	7.04 KB

Added patch for the above fixes here, please review it.

Comment #3

arisen

Goa, GMT +5:30

commented 1 February 2023 at 10:41

Status:

Needs review

» Needs work

Status	File	Size
new	color_field_patch_on_3.0.x.png	291.15 KB

Reviewed the patch on 3.0.x branch. The patch is applying cleanly but getting additional code standards error.

FILE: ...color_field/src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php
----------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------
 70 | ERROR | Unknown type hint "mixed" found for $plugin_definition
----------------------------------------------------------------------------------------------------------

Time: 921ms; Memory: 12MB

Comment #4

adil_siddiqui commented 16 February 2023 at 10:10

Status:

Needs work

» Needs review

Status	File	Size
new	3338149-4.patch	8.03 KB

Patch created with all above issue fixed

Comment #5

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 16 February 2023 at 13:59

Title:	Drupal Coding Standards Issues \| phpcs	» Fix the issues reported by phpcs
Category:	Bug report	» Task

Comment #6

1 March 2023 at 10:22

urvashi_vora made their first commit to this issue’s fork.

Comment #7

urvashi_vora commented 1 March 2023 at 10:29

Assigned:	Unassigned	» urvashi_vora
Status:	Needs review	» Needs work

Reviewed and Tested Patch 3338149-4.patch.

The patch applied smoothly

urvasi@urvasi-Inspiron-15-3552:/var/www/html/contribution/drupal/web/modules/contrib/color_field-3338149$ git apply -v 3338149-4.patch
Checking patch src/ColorHex.php...
Checking patch src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php...
Checking patch tests/src/Functional/ColorFieldFormatterTest.php...
Checking patch tests/src/Functional/ColorFieldFormatterTokenTest.php...
Checking patch tests/src/Functional/ColorFieldWidgetTest.php...
Applied patch src/ColorHex.php cleanly.
Applied patch src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php cleanly.
Applied patch tests/src/Functional/ColorFieldFormatterTest.php cleanly.
Applied patch tests/src/Functional/ColorFieldFormatterTokenTest.php cleanly.
Applied patch tests/src/Functional/ColorFieldWidgetTest.php cleanly.

Still there are a few issues left, which can fixed by phpcbf, I will fix them and create a MR.

urvasi@urvasi-Inspiron-15-3552:/var/www/html/contribution/drupal/web/modules/contrib$ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,js,info,txt,md,yml,twig color_field-3338149/

FILE: ...dules/contrib/color_field-3338149/js/color_field_widget_spectrum.jquery.js
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
 29 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but
    |       |     found "true"
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------


FILE: ...upal8/web/modules/contrib/color_field-3338149/js/color_field_widget_box.js
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 21 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but
    |       |     found "true"
 23 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL" but
    |       |     found "null"
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Time: 2.46 secs; Memory: 12MB

Comment #8

urvashi_vora commented 1 March 2023 at 10:30

Assigned:	urvashi_vora	» Unassigned
Status:	Needs work	» Needs review

Fixed all the issue, Please review.

urvasi@urvasi-Inspiron-15-3552:/var/www/html/contribution/drupal/web/modules/contrib$ phpcbf --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,js,info,txt,md,yml,twig color_field-3338149/

PHPCBF RESULT SUMMARY
--------------------------------------------------------------------------------
FILE                                                            FIXED  REMAINING
--------------------------------------------------------------------------------
...olor_field-3338149/js/color_field_widget_spectrum.jquery.js  1      0
...es/contrib/color_field-3338149/js/color_field_widget_box.js  2      0
--------------------------------------------------------------------------------
A TOTAL OF 3 ERRORS WERE FIXED IN 2 FILES
--------------------------------------------------------------------------------

Time: 2.55 secs; Memory: 12MB

Comment #9

1 March 2023 at 10:32

urvashi_vora opened merge request !13

Comment #10

paraderojether commented 9 June 2023 at 02:27

Status:

Needs review

» Reviewed & tested by the community

Status	File	Size
new	before patch.png	279.9 KB
new	after patch.png	109.12 KB

I reviewed MR!13, and applied it against Color Field 3.0.x-dev cleanly and confirmed it fixes all the issues reported by phpcs.

I added screenshots for reference.
Thank You.

Comment #11

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 9 June 2023 at 07:50

Priority:	Normal	» Minor
Status:	Reviewed & tested by the community	» Needs work

Comment #12

15 November 2023 at 09:42

Yashaswi18 made their first commit to this issue’s fork.

Comment #13

zkhan.aamir commented 2 January 2024 at 07:55

Issue tags:

+Coding standards

Comment #14

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 2 January 2024 at 08:05

The MR is still using NULL and TRUE in JavaScript files, while they are used in PHP code. In JavaScript, it is correct to use null and true.

Comment #15

2 January 2024 at 12:10

sakthi_dev made their first commit to this issue’s fork.

Comment #16

sakthi_dev commented 2 January 2024 at 12:11

Status:

Needs work

» Needs review

Updated to lower case in JS.

Comment #17

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 7 January 2024 at 15:48

Status:

Needs review

» Needs work

Comment #18

sakthi_dev commented 17 January 2024 at 14:22

Status:

Needs work

» Needs review

Addressed comments in MR. Please review.

Comment #19

nikolay shapovalov commented 18 January 2024 at 09:51

Issue summary:

View changes

Update IS, add new phpcs report.

Comment #20

nikolay shapovalov commented 18 January 2024 at 10:11

Status:

Needs review

» Needs work

Please remove changes that is not necessary, and not marked as violation by phpcs report.

Comment #21

nikolay shapovalov commented 18 January 2024 at 10:11

5 files were hidden/shown/deleted

Status	File	Size
hidden	3338149-2.patch	7.04 KB
hidden	color_field_patch_on_3.0.x.png	291.15 KB
hidden	3338149-4.patch	8.03 KB
hidden	before patch.png	279.9 KB
hidden	after patch.png	109.12 KB

Needs work

» Needs review

Comment #26

silvi.addweb commented 10 June 2024 at 06:35

Status:

Needs review

» Reviewed & tested by the community

Hi, I have tested MR 22. There are no remaining issues. Moving to RTBC.

addweb@addweb-HP-ZBook-15-G2:~$ .config/composer/vendor/squizlabs/php_codesniffer/bin/phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml,css Drupal8-vagrant/web/web/contribution/drupal-10-3/web/modules/custom/color_field/
addweb@addweb-HP-ZBook-15-G2:~$

Italian

Brescia, 🇮🇹 🇪🇺

commented 10 June 2024 at 07:11

Status:

Reviewed & tested by the community

» Closed (outdated)

GitLAb CI does not report any PHP_CodeSniffer warning/error that should be fixed.