Phpcs Drupal coding standard issue

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.

To make it clearer, the issue summary does not show which arguments were passed to phpcs to get the quoted report.

There are some errors and warning left that need to be fixed, related to Drupal practice.

I have rebased the branch and fixed the conflict in README.md file

hey ,
There are still some error. please find it below.

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml web/modules/contrib/imageapi_optimize

FILE: /Users/prabue/Desktop/Projects/drupal-9/web/modules/contrib/imageapi_optimize/imageapi_optimize.api.php
-------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------
22 | ERROR | Type hint "array" missing for $processors
-------------------------------------------------------------------------------------------------------------

FILE: /Users/prabue/Desktop/Projects/drupal-9/web/modules/contrib/imageapi_optimize/src/ImageAPIOptimizeProcessorPluginCollection.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
-------------------------------------------------------------------------------------------------------------------------------------
23 | WARNING | Possible useless method overriding detected
-------------------------------------------------------------------------------------------------------------------------------------

FILE: /Users/prabue/Desktop/Projects/drupal-9/web/modules/contrib/imageapi_optimize/src/ImageAPIOptimizePipelineInterface.php
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
23 | WARNING | The @see url '\Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()' does not match the standard: http(s)://www.drupal.org/node/n or
| | http(s)://www.drupal.org/project/aaa/issues/n
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Time: 806ms; Memory: 12MB

These issues are remaining

FILE: ...esktop\Contrib\imageapi_optimize\src\ImageAPIOptimizePipelineInterface.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 23 | WARNING | The @see url
    |         | '\Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()'
    |         | does not match the standard: http(s)://www.drupal.org/node/n or
    |         | http(s)://www.drupal.org/project/aaa/issues/n
--------------------------------------------------------------------------------


FILE: ...ontrib\imageapi_optimize\src\ImageAPIOptimizeProcessorPluginCollection.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 23 | WARNING | Possible useless method overriding detected
--------------------------------------------------------------------------------

Time: 1.84 secs; Memory: 10MB

Actually, as per Drupal coding standard → , @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId() is correct.

Hi,
Applied the MR!5 found one warning.

FILE: /imageapi_optimize/src/ImageAPIOptimizePipelineInterface.php
------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------------------
 23 | WARNING | The @see url '\Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()' does not match the standard:
    |         | http(s)://www.drupal.org/node/n or http(s)://www.drupal.org/project/aaa/issues/n
------------------------------------------------------------------------------------------------------------------------------------------------------------

Hi @nitin_lama,

The latest changes you made on MR!5 was applied successfully but it still reported 1 file with a warning. Please see:

imageapi_optimize git:(4.x) curl https://git.drupalcode.org/project/imageapi_optimize/-/merge_requests/5.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 57816    0 57816    0     0  97849      0 --:--:-- --:--:-- --:--:-- 99682
patching file README.md
patching file imageapi_optimize.api.php
patching file imageapi_optimize.install
patching file imageapi_optimize.module
patching file src/Annotation/ImageAPIOptimizeProcessor.php
patching file src/Entity/ImageAPIOptimizePipeline.php
patching file src/Entity/ImageStyleWithPipeline.php
patching file src/Exception/PluginNotFoundException.php
patching file src/Form/ImageAPIOptimizeDefaultPipelineConfigForm.php
patching file src/Form/ImageAPIOptimizePipelineDeleteForm.php
patching file src/Form/ImageAPIOptimizePipelineEditForm.php
patching file src/Form/ImageAPIOptimizeProcessorAddForm.php
patching file src/Form/ImageAPIOptimizeProcessorDeleteForm.php
patching file src/Form/ImageAPIOptimizeProcessorEditForm.php
patching file src/Form/ImageAPIOptimizeProcessorFormBase.php
patching file src/ImageAPIOptimizeHookImplementations.php
patching file src/ImageAPIOptimizePipelineInterface.php
patching file src/ImageAPIOptimizePipelineListBuilder.php
patching file src/ImageAPIOptimizePipelineStorage.php
patching file src/ImageAPIOptimizePipelineStorageInterface.php
patching file src/ImageAPIOptimizeProcessorBase.php
patching file src/ImageAPIOptimizeProcessorInterface.php
patching file src/ImageAPIOptimizeProcessorPluginCollection.php
patching file src/ImageStyleWithPipelineListBuilder.php
patching file tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorAppendCharacters.php
patching file tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorBlackPNG.php
patching file tests/module/imageapi_optimize_module_test/src/Plugin/ImageAPIOptimizeProcessor/TestProcessorFailedGreenPNG.php
patching file tests/src/Functional/FileMoveTest.php
patching file tests/src/Functional/ImageAdminStylesTest.php
patching file tests/src/Functional/ImageDimensionsTest.php
patching file tests/src/Functional/ImageFieldDefaultImagesTest.php
patching file tests/src/Functional/ImageFieldDisplayTest.php
patching file tests/src/Functional/ImageFieldValidateTest.php
patching file tests/src/Functional/ImageFieldWidgetTest.php
patching file tests/src/Functional/ImageOnTranslatedEntityTest.php
patching file tests/src/Functional/ImageStyleDeleteTest.php
patching file tests/src/Functional/ImageStyleFlushTest.php
patching file tests/src/Functional/ImageStylesPathAndUrlTest.php
patching file tests/src/Functional/QuickEditImageControllerTest.php
patching file tests/src/FunctionalJavascript/ImageAdminStylesTest.php
patching file tests/src/FunctionalJavascript/ImageFieldValidateTest.php
patching file tests/src/FunctionalJavascript/QuickEditImageTest.php
patching file tests/src/Kernel/ImageEffectsTest.php
patching file tests/src/Kernel/ImageFormatterTest.php
patching file tests/src/Kernel/ImageImportTest.php
patching file tests/src/Kernel/ImageItemTest.php
patching file tests/src/Kernel/ImageOptimizePipelineTest.php
patching file tests/src/Kernel/ImageStyleCustomStreamWrappersTest.php
patching file tests/src/Kernel/ImageStyleIntegrationTest.php
patching file tests/src/Kernel/ImageThemeFunctionTest.php
patching file tests/src/Kernel/Migrate/d6/MigrateImageCacheTest.php
patching file tests/src/Kernel/Migrate/d7/MigrateImageSettingsTest.php
patching file tests/src/Kernel/Migrate/d7/MigrateImageStylesTest.php
patching file tests/src/Kernel/Views/ImageViewsDataTest.php
patching file tests/src/Kernel/Views/RelationshipUserImageDataTest.php
➜  imageapi_optimize git:(4.x) ✗ cd ..
➜  contrib git:(master) ✗ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig imageapi_optimize

FILE: ...odules/contrib/imageapi_optimize/src/ImageAPIOptimizePipelineInterface.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
 23 | WARNING | The @see url
    |         | '\Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()'
    |         | does not match the standard: http(s)://www.drupal.org/node/n or
    |         | http(s)://www.drupal.org/project/aaa/issues/n
--------------------------------------------------------------------------------

Time: 742ms; Memory: 12MB

Kindly check

Thanks,
Jake

avpaderno → changed the visibility of the branch 3351047-phpcs-drupal-coding to hidden.

avpaderno → changed the visibility of the branch 3351047-gitlab-ci-reports to hidden.

Let's continue in 📌 Fix the issues reported by phpcs Needs review rather than having 2 issues.

Actually, let's continue here!

Let's open a new MR with PHP CS enabled.