Fix the issues reported by phpcs

Hello,

I have created a patch to solve all the errors related to phpcs code standard within the .module file .
Please review and apply it

I have tested your patch 3370177-#2.patch @prachi6824, it's working fine

The issue summary should always describe what the issue is trying to fix and, in the case of coding standards issues, show which command and arguments have been used and which report that command shown. In this way, project maintainers can verify the patch/MR fixes all the warnings/errors.

Hello @apaderno,

I will go through my summary again and will update it with more clarifications.
Thank you for reviewing my summary.

Problem/Motivation

There are issues found in the .module file which are reported by PHP code sniffer.
All the issues are mentioned above in the #1 comment issue summary.

Steps to reproduce:

1) Install the module.

2) Run this php code standard command to detect the errors reporeted by the php code sniffer.
phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml /path/to/drupal/example_module

3) Mention the proper path of the .module file or the file in which you want to detect the error.

4) After running the command start solving the issues which are given by going to the line no. mentioned in the error.

5) For further better understanding of the issue please do refer the following link which tells @deprecated PHPdoc tag format :

https://www.drupal.org/about/core/policies/core-change-policies/drupal-d... →

Proposed resolution:

Edit the code and solve the issue by implementing the correct code format.

The issue summary has not yet updated.

Updated issue summary again.

Truly, the issue summary has been updated once.

The status is also for the patch that failed to apply and that needs to be changed.

diff --git a/modules/contrib/codemirror_editor/codemirror_editor.module b/modules/contrib/codemirror_editor/codemirror_editor.module
index e5e058e9..752b1d15 100644
--- a/modules/contrib/codemirror_editor/codemirror_editor.module
+++ b/modules/contrib/codemirror_editor/codemirror_editor.module

The patch needs to be created from the directory containing the project files.

Ok @apaderno I will work on the patch again and will recreate the patch to solve the issues.
Thank You.

minor change in CodeMirrorEditorWidget.php file.

phpcbf --standard=Drupal your_module_directory

Hi

I reviewed patch #1, and there are still phpcs issues remaining shown below:

codemirror_editor git:(147c3b7) curl https://www.drupal.org/files/issues/2023-07-31/CodeMirrorEditorWidget.php-3370177-14.patch | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   663  100   663    0     0    360      0  0:00:01  0:00:01 --:--:--   361
patching file 'src/Plugin/Field/FieldWidget/CodeMirrorEditorWidget.php'
➜  codemirror_editor git:(147c3b7) ✗ cd ..
➜  contrib phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig codemirror_editor

FILE: /Users/jetherparadero/Q2_DO/q2_issues/web/modules/contrib/codemirror_editor/codemirror_editor.module
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 4 LINES
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 62 | ERROR | The text '@deprecated Use Drupal\codemirror_editor\CodemirrorModeManagerInterface::getDefinitions() instead.' does not match the standard format: @deprecated in
    |       | %deprecation-version% and is removed from %removal-version%. %extra-info%.
 62 | ERROR | Each @deprecated tag must have a @see tag immediately following it
 67 | ERROR | The trigger_error message 'codemirror_editor_load_modes() is deprecated. Use Drupal\codemirror_editor\CodemirrorModeManagerInterface::getDefinitions() instead'
    |       | does not match the strict standard format: %thing% is deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%. See %cr-link%
 80 | ERROR | The text '@deprecated Use Drupal\codemirror_editor\CodemirrorModeManagerInterface::normalizeMode() instead.' does not match the standard format: @deprecated in
    |       | %deprecation-version% and is removed from %removal-version%. %extra-info%.
 80 | ERROR | Each @deprecated tag must have a @see tag immediately following it
 85 | ERROR | The trigger_error message 'codemirror_editor_load_modes() is deprecated. Use Drupal\codemirror_editor\CodemirrorModeManagerInterface::normalizeMode() instead' does
    |       | not match the strict standard format: %thing% is deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%. See %cr-link%
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------


FILE: /Users/jetherparadero/Q2_DO/q2_issues/web/modules/contrib/codemirror_editor/src/CodeMirrorLibraryBuilder.php
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 8 | ERROR | The text '@deprecated Use \Drupal\codemirror_editor\LibraryBuilder' does not match the standard format: @deprecated in %deprecation-version% and is removed from
   |       | %removal-version%. %extra-info%.
 8 | ERROR | Each @deprecated tag must have a @see tag immediately following it
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Time: 610ms; Memory: 12MB

Thank you.

GitLab CI no longer reports PHP_CodeSniffer warnings/errors.

There are still quite a few phpcs issues left related to incorrect deprecation notices:

The text '@deprecated Use \Drupal\codemirror_editor\LibraryBuilder' does not match the standard format:
@deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%.

All of these deprecations were deprecated 6 years ago, but no "deprecation-version" or "removal-version" was ever given. I'd say, we deprecate them now for 8.x-1.10 and remove them inside a new Drupal 11 "2.x" branch.

All green, talked with @Anybody about these changes internally, so RTBC'ing right away.

All the given patches were only very minor changes or incorrect, meaning I'll only credit @avpaderno. Sorry y'all.

Automatically closed - issue fixed for 2 weeks with no activity.