Fix the issues reported by phpcs

FILE: /var/www/html/web/modules/custom/geshifilter-3297301/src/Form/GeshiFilterSettingsForm.php ----------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 15 WARNINGS AFFECTING 15 LINES ----------------------------------------------------------------------------------------------- 56 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 57 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 92 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 136 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 153 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 162 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 196 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 197 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 198 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 237 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 298 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 303 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead 331 | WARNING | #options values usually have to run through t() for translation 332 | WARNING | #options values usually have to run through t() for translation 374 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead ----------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/src/GeshiFilter.php ---------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES ---------------------------------------------------------------------------------------------------------------------------------------- 173 | WARNING | Unused variable $filename. 182 | ERROR | The array declaration extends to column 92 (the limit is 80). The array content should be split up over multiple lines ---------------------------------------------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/src/Plugin/Filter/GeshiFilterFilter.php --------------------------------------------------------------------------------------------------------------------------------------------- FOUND 10 ERRORS AND 9 WARNINGS AFFECTING 12 LINES --------------------------------------------------------------------------------------------------------------------------------------------- 85 | ERROR | [x] list(...) is forbidden, use [...] instead. 107 | ERROR | [ ] The array declaration extends to column 112 (the limit is 80). The array content should be split up over multiple lines 133 | ERROR | [x] list(...) is forbidden, use [...] instead. 133 | WARNING | [ ] Unused variable $tag_to_lang. 146 | WARNING | [x] '@todo: make sure that these replacements can be done in series.' should match the format '@todo Fix problem X here.' 227 | ERROR | [x] list(...) is forbidden, use [...] instead. 272 | ERROR | [ ] The array declaration extends to column 126 (the limit is 80). The array content should be split up over multiple lines 368 | ERROR | [x] list(...) is forbidden, use [...] instead. 501 | WARNING | [x] '@todo: recreate a cache for this function.' should match the format '@todo Fix problem X here.' 716 | ERROR | [x] list(...) is forbidden, use [...] instead. 716 | WARNING | [ ] Unused variable $generic_code_tags. 778 | ERROR | [x] list(...) is forbidden, use [...] instead. 778 | WARNING | [ ] Unused variable $generic_code_tags. 910 | ERROR | [x] list(...) is forbidden, use [...] instead. 910 | WARNING | [ ] Unused variable $generic_code_tags. 910 | WARNING | [ ] Unused variable $language_tags. 982 | ERROR | [x] list(...) is forbidden, use [...] instead. 982 | WARNING | [ ] Unused variable $generic_code_tags. 982 | WARNING | [ ] Unused variable $language_tags. --------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 10 MARKED SNIFF VIOLATIONS AUTOMATICALLY --------------------------------------------------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/tests/src/Functional/GeshiFilterAdministrationTest.php ------------------------------------------------------------------------------------------------------------------------------------------ FOUND 0 ERRORS AND 7 WARNINGS AFFECTING 7 LINES ------------------------------------------------------------------------------------------------------------------------------------------ 107 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 108 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 116 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 117 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 169 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 170 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 182 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead ------------------------------------------------------------------------------------------------------------------------------------------ FILE: /var/www/html/web/modules/custom/geshifilter-3297301/tests/src/Functional/GeshiFilterCssTest.php ------------------------------------------------------------------------------------------------------------------------------------------ FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES ------------------------------------------------------------------------------------------------------------------------------------------ 121 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 155 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 188 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 216 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 217 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead ------------------------------------------------------------------------------------------------------------------------------------------ FILE: /var/www/html/web/modules/custom/geshifilter-3297301/tests/src/Functional/GeshiFilterTest.php ---------------------------------------------------------------------------------------------------------------------------------------------- FOUND 1 ERROR AND 44 WARNINGS AFFECTING 45 LINES ---------------------------------------------------------------------------------------------------------------------------------------------- 136 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 137 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 177 | ERROR | [x] list(...) is forbidden, use [...] instead. 208 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 211 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 214 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 221 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 227 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 230 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 233 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 236 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 239 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 258 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 262 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 265 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 268 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 286 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 290 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 293 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 296 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 315 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 319 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 322 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 325 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 344 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 348 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 351 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 354 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 373 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 377 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 380 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 383 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 403 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 406 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 426 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 429 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 448 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 452 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 456 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 468 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 481 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 493 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 506 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 525 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 528 | WARNING | [ ] t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead ---------------------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ---------------------------------------------------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/config/install/geshifilter.settings.yml -------------------------------------------------------------------------------------------------- FOUND 4 ERRORS AFFECTING 4 LINES -------------------------------------------------------------------------------------------------- 1 | ERROR | [x] Missing file doc comment 39 | ERROR | [x] Perl-style comments are not allowed; use "// Comment" instead 47 | ERROR | [x] Perl-style comments are not allowed; use "// Comment" instead 50 | ERROR | [x] Perl-style comments are not allowed; use "// Comment" instead -------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY -------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/codesnippetgeshi/src/Controller/GeshiController.php ----------------------------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ----------------------------------------------------------------------------------------------------------------- 11 | WARNING | The class short comment should describe what the class does and not simply repeat the class name ----------------------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/codesnippetgeshi/src/Plugin/CKEditorPlugin/CodeSnippetGeshiCKEditorButton.php ----------------------------------------------------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ----------------------------------------------------------------------------------------------------------------------------------------- 25 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead ----------------------------------------------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/codesnippetgeshi/codesnippetgeshi.info.yml ----------------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ----------------------------------------------------------------------------------------------------- 7 | WARNING | All dependencies must be prefixed with the project name, for example "drupal:" ----------------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/codesnippetgeshi/README.txt -------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE -------------------------------------------------------------------------------------- 46 | WARNING | Line exceeds 80 characters; contains 84 characters -------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshi-extra/drupal5.php ---------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ---------------------------------------------------------------------------------- 22 | WARNING | Unused variable $language_data. ---------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshi-extra/drupal6.php ---------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ---------------------------------------------------------------------------------- 21 | WARNING | Unused variable $language_data. ---------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshifield/src/Plugin/Field/FieldWidget/GeshiFieldDefaultWidget.php ------------------------------------------------------------------------------------------------------------------------------ FOUND 2 ERRORS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------ 32 | ERROR | [x] Use null coalesce operator instead of ternary operator. 37 | ERROR | [x] Use null coalesce operator instead of ternary operator. ------------------------------------------------------------------------------------------------------------------------------ PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------ FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshifield/src/Plugin/Field/FieldFormatter/GeshiFieldDefaultFormatter.php ------------------------------------------------------------------------------------------------------------------------------------ FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE ------------------------------------------------------------------------------------------------------------------------------------ 32 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead ------------------------------------------------------------------------------------------------------------------------------------ FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshifield/tests/src/Functional/GeshiFieldTest.php ------------------------------------------------------------------------------------------------------------------------------------------ FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES ------------------------------------------------------------------------------------------------------------------------------------------ 114 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead 115 | WARNING | t() calls should be avoided in classes, use \Drupal\Core\StringTranslation\StringTranslationTrait and $this->t() instead ------------------------------------------------------------------------------------------------------------------------------------------ FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshifield/geshifield.info.yml ---------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES ---------------------------------------------------------------------------------------------- 7 | WARNING | All dependencies must be prefixed with the project name, for example "drupal:" 8 | WARNING | All dependencies must be prefixed with the project name, for example "drupal:" ---------------------------------------------------------------------------------------------- FILE: /var/www/html/web/modules/custom/geshifilter-3297301/geshifield/geshifield.module --------------------------------------------------------------------------------------------------------------------------------- FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE --------------------------------------------------------------------------------------------------------------------------------- 7 | WARNING | [x] '@todo: is the GeSHi CSS file always loaded when needed?' should match the format '@todo Fix problem X here.' --------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY ---------------------------------------------------------------------------------------------------------------------------------

Comments & Activities

Not all content is available!

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

Assigned to dineshkumarbollu
Issue was unassigned.
Status changed to Needs review almost 2 years ago11:23am 20 January 2023
Status changed to Needs work over 1 year ago8:47pm 1 May 2023
Comment over 1 year ago →
🇮🇹Italy apaderno Brescia, 🇮🇹
The issue summary should always describe what the issue is trying to fix and, in the case, of coding standards issues, show which command has been used, which arguments have been used, and which report that command shown.
Comment over 1 year ago →
🇨🇦Canada imustakim Canada
Status changed to Needs review over 1 year ago1:35pm 3 May 2023
Comment over 1 year ago →
🇨🇦Canada imustakim Canada
Issue summary updated.
Comment over 1 year ago →
🇮🇹Italy apaderno Brescia, 🇮🇹
Status changed to Needs work over 1 year ago8:16pm 3 May 2023

Comment over 1 year ago →

🇮🇹Italy apaderno Brescia, 🇮🇹

 /**
- * Class GeshiController.
+ * Class GeshiController.Request provide.
  */
 class GeshiController extends ControllerBase {

A class short description must not start with Class nor repeat the class name.
Request provide. does not describe the class's purpose.

       'CodeSnippet' => [
-        'label' => t('Add a button to use codesnippetgeshi plugin.'),
+        'label' => 'Add a button to use codesnippetgeshi plugin.',
         'image' => drupal_get_path('module', 'codesnippetgeshi') . '/icons/codesnippet.png',
       ],
     ];

The existing code is correct: A label needs to translatable.

--- a/config/install/geshifilter.settings.yml
+++ b/config/install/geshifilter.settings.yml
@@ -1,3 +1,10 @@
+<?php
+
+/**
+ * @file
+ * {@inheritdoc}
+ */
+?>
 # Use a specific options for each filter format.

A YAML file is not a PHP file. I do not see anything in the report that says that change is necessary or correct.

-# - 16 ```cpp Markdown code block.
+// - 16 ```cpp Markdown code block.
 tag_styles:
   1: 1
   2: 2
@@ -44,10 +51,10 @@ tag_styles:
   8: 0
   16: 0
 
-# Tab width, the default from geshi is 8.
+// Tab width, the default from geshi is 8.
 tab_width: 8
 
-# Default languages and tags.
+// Default languages and tags.
 language:

YAML files do not use the same comment delimiters PHP uses.

-  - field
-  - geshifilter
+  - field:field
+  - geshifilter:field

Those dependencies are wrong, but the changed dependencies are wrong too.
The format is [project name]:[module name]. The first dependency uses the wrong project name; the second dependency changes the module name from geshifilter to field.

- * @todo: is the GeSHi CSS file always loaded when needed?
+ * @todo is the GeSHi CSS file always loaded when needed?
  */

What follows @todo is a sentence: It starts with a capitalized word and ends with a period (preferably), a question mark, or an exclamation point. The period is preferable as usually what follows @todo should state what needs to be changed.

   /**
    * {@inheritdoc}
    */
+

That comment must be removed.

+  /**
+   * Construtor for the class.
+   */
+  public function __construct(RendererInterface $renderer) {

The short description for a class constructor starts with Constructs a new followed by the class name (namespace included) and ends with object.
The documentation comment must also describe the parameters, but not the return value.

+  /**
+   * Implements create().
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('renderer')
+    );
+  }

Methods inherited by a parent class or defined by an interface have a different documentation comment.

+  /**
+   * Function to render items.
+   */
   public function viewElements(FieldItemListInterface $items, $langcode) {
     $elements = [];

Short descriptions for methods do not start with Function. I guess that is an inherited method or a method defined in an interface; it means its documentation comment is different.

Comment about 1 year ago →
bindu r
bindu r → made their first commit to this issue’s fork.

Fix the issues reported by phpcs

Problem/Motivation

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Comments & Activities