Fix the issues reported by phpcs

Created on 24 May 2023, over 1 year ago
Updated 19 July 2024, 4 months ago
šŸ“Œ Task
Status

Needs work

Version

1.1

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.

  • Needs reroll

    The patch will have to be re-rolled with new suggestions/changes described in the comments in the issue.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @urvashi_vora
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India

    Assigned to myself, will provide a patch ASAP.

    Thanks

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India

    Please review this patch. Thanks.

  • Status changed to Needs work over 1 year ago
  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹
     /**
      * @file
    - * Contains gravitas_countdown.module.
    + * Hook implementations for gravitas_countdown module.
      */

    The usual module description is Hook implementations for the [module name] module. where [module name] is replaced by the module name shown in the .info.yml file.

    + * Get previous image ids of the countdown.
    + *
    + * @param string $countdown_data_config
    + *   The configuration data for the countdown.
    + *
    + * @return array
    + *   An array of previous image IDs.
      */
    -function get_countdown_description_images($countdown_data_config)
    -{
    -  $image_ids = array();
    +function get_countdown_description_images($countdown_data_config) {

    Since that documentation comment is edited:

    • The verb used in the description must use the third person singular
    • ids is misspelled and it must be corrected
    • Assuming that the description is about countdown images, a better description would be Gets the previous countdown image IDs.
     /**
    - * form alter block_delete_form to delete the images used
    - * on the block
    - * @param  [type]             &$form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Implements Form alter block_delete_form.
    + *
    + * To delete the images used on the block.
    + *
    + * @param array &$form
    + *   The form being altered.
    + * @param \Drupal\Core\Form\FormStateInterface $form_state
    + *   The current state of the form.
      */
    -function gravitas_countdown_form_alter(&$form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_alter(array &$form, FormStateInterface $form_state) {

    Since that is a hook implementation, the documentation comment is shorter.
    The description is not correct.

    -    // get block entity
    +    // Get block entity.
         if ($block_entity) {

    A definite article is missing in the comment.

    -      // check if the plugin id is gravitas_countdown
    +      // Check if the plugin id is gravitas_countdown.
           if ($block_plugin_id == 'gravitas_countdown') {

    That comment is not necessary, since it describes something that is clear from the code.

     /**
    - * submit form callback to remove the images used
    - * on the countdown block
    - * @param  [type]             $form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Submit form callback.
    + *
    + * To remove the images used on the countdown block.
    + *
    + * @param array $form
    + *   The form being submitted.
    + * @param \Drupal\Core\Form\FormStateInterface $form_state
    + *   The current state of the form.
      */
    -function gravitas_countdown_form_submit($form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_submit(array $form, FormStateInterface $form_state) {

    Since that is a form submission handler, its documentation comment is different.
    The hook description must make clear to which form the submission handler is added, which is usually done by using the form ID.

    + * @return array
    + *   An array of file IDs used in the countdown editor.
      */
    -function get_countdown_editor_files($content)

    It is not necessary to repeat the return value type, in the return value description.

     /**
    -* Implements theme_mymodule_thumb_upload theme callback.
    -*/
    + * Implements theme_mymodule_thumb_upload theme callback.
    + */
     function theme_mymodule_thumb_upload($variables) {
     /**
    -* Implements theme_mymodule_thumb_upload theme callback.
    -*/
    + * Implements theme_mymodule_thumb_upload theme callback.
    + */
     function theme_mymodule_thumb_upload($variables) {

    Not considering that Drupal 8/9/10 do not have anymore theme implementations, the documentation comment for theme implementations is different. It is like the following one, for example.

    /**
     * Returns HTML for a select form element.
     *
     * It is possible to group options together; to do this, change the format of
     * $options to an associative array in which the keys are group labels, and the
     * values are associative arrays in the normal $options format.
     *
     * @param $variables
     *   An associative array containing:
     *   - element: An associative array containing the properties of the element.
     *     Properties used: #title, #value, #options, #description, #extra,
     *     #multiple, #required, #name, #attributes, #size.
     *
     * @ingroup themeable
     */
    function theme_select($variables) {
      $element = $variables['element'];
      element_set_attributes($element, array('id', 'name', 'size'));
      _form_set_class($element, array('form-select'));
      return '<select' . drupal_attributes($element['#attributes']) . '>' . form_select_options($element) . '</select>';
    }
    
    -  // The remove button is already taken care of by rendering the rest of the form. No need to hack up some HTML!
    +  // The remove button is already taken care of
    +  // by rendering the rest of the form.
    +  // No need to hack up some HTML!
    

    Avoiding that lines exceed 80 characters does not mean making them too short.

    +            var counter = setInterval(function () {
    +                var now = new Date().getTime();
    +                var daysInnerText, hoursInnerText, minutesInnerText, secondsInnerText;
    +                var distance = countDown - now;
    +                if(distance < 0) {
    

    The lines after the first are not correctly indented.
    There must be a space between if and the next parenthesis.

  • Assigned to urvashi_vora
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India

    Hi,

    I modified the patch accordingly, please review.

    Also, @apaderno, for the point where you gave feedback for:

    +            var counter = setInterval(function () <strong>{</strong>
    +                var now = new Date().getTime();
    +                var daysInnerText, hoursInnerText, minutesInnerText, secondsInnerText;
    +                var distance = countDown - now;
    +                if(distance < 0) {
    
    The lines after the first are not correctly indented.
    There must be a space between if and the next parenthesis.

    It is important to note that all the lines in the code are properly indented. There might have been some confusion due to the initial lines starting with "var" and the curly brace not being clearly visible. Such confusions can happen, and I appreciate your understanding. Nevertheless, I have made the necessary changes as requested in the rest of the code. Thank you for bringing the rest of the issues to my attention.

  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹

    Indentation in JavaScript files is two spaces. That means that each time the indentation is increased, it is increased of two spaces, not four.
    The fact the previous line starts a function does not change that. Otherwise, Drupal core will not format the following code as it does.

          $row.find('.js-real-checkbox').each(function () {
            this.style.display = authCheckbox.checked ? 'none' : '';
          });
          $row.find('.js-dummy-checkbox').each(function () {
            this.style.display = authCheckbox.checked ? '' : 'none';
          });
    
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India

    Formatted the file with two space indentation.

  • Status changed to Needs work over 1 year ago
  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹
     /**
      * @file
    - * Contains gravitas_countdown.module.
    + * Hook implementations for Gravitas Countdown module.
      */
    

    The description is missing a definite article after for.

     /**
    - * form alter block_delete_form to delete the images used
    - * on the block
    - * @param  [type]             &$form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Implements hook_form_alter().
    + *
    + * Hook used to delete the images used on the block.
      */
    -function gravitas_countdown_form_alter(&$form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_alter(array &$form, FormStateInterface $form_state) {

    For hook implementations, the description starts with Implements followed by the hook name.

    + * Removes the images used on the countdown block
    + * after the block_delete_form form submission.
    + * This submission handler, gravitas_countdown_form_submit,
    + * is added to the block_delete_form form
    + * when the block entity's plugin ID is 'gravitas_countdown'.
    + *
    + * @param array $form
    + *   The form being submitted.
    + * @param \Drupal\Core\Form\FormStateInterface $form_state
    + *   The current state of the form.
      */
    -function gravitas_countdown_form_submit($form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_submit(array $form, FormStateInterface $form_state) {

    The documentation comment for form submission handlers is different from the documentation comments for other functions. API documentation and comment standards / Form-generating functions ā†’ shows an example of documentation comment for a form validation handler and a forum submission handler.

     /**
    - * @param $content
    + * Retrieves the file IDs associated with the countdown editor content.
    + *
    + * @param string $content
    + *   The content of the countdown editor.
    + *
      * @throws \Drupal\Core\Entity\EntityStorageException
    + *   If there is an error loading the file entities.
    + *
    + * @return array
    + *   An array of file IDs used in the countdown editor.
      */
    

    As per Drupal API documentation standards for order of documentation sections ā†’ , the @throws line must be after the @return line.
    @throws: Thrown exceptions ā†’ says:

    Drupal standards notes: The name of an exception class should appear on the same line as the @throws tag. Put explanations in starting on the next line, but only if they tell you something useful that is not conveyed by the name of the class. If you include an explanation, like other documentation use complete sentences that stand alone, without assuming that "Throws [exception name]" is part of the sentence automatically, since Throws will be a heading when it's displayed on api.drupal.org.

    -* Implements theme_mymodule_thumb_upload theme callback.
    -*/
    + * Theme function for rendering the thumbnail upload element.
    + *
    + * Renders the HTML output for the thumbnail upload element,
    + * including the image preview and additional widget data.
    + */
     function theme_mymodule_thumb_upload($variables) {

    The (short) description must be a single line and not exceed 80 characters (with the usual exceptions).
    As shown in Themeable functions ā†’ , the parameter must be described.

    /**
     * Returns HTML for a foo.
     *
     * @param array $variables
     *   An associative array containing:
     *   - foo: The foo object that is being formatted.
     *   - show_bar: TRUE to show the bar component, FALSE to omit it.
     *
     * @ingroup themeable
     */
    function theme_foo($variables) {
    
       // My uploaded element didn't have a preview array item, so this didn't work
    -  //if (isset($element['preview'])) {
    -  //  $output .= '<div class="image-preview">';
    -  //  $output .= drupal_render($element['preview']);
    -  //  $output .= '</div>';
    -  //}
    -
    -  // If image is uploaded show its thumbnail to the output HTML
    +  // if (isset($element['preview'])) {
    +  // $output .= '<div class="image-preview">';
    +  // $output .= drupal_render($element['preview']);
    +  // $output .= '</div>';
    +  // }
    

    Even for commented out code, the indentation must be preserved. The existing code is the following one.

      // My uploaded element didn't have a preview array item, so this didn't work
      //if (isset($element['preview'])) {
      //  $output .= '<div class="image-preview">';
      //  $output .= drupal_render($element['preview']);
      //  $output .= '</div>';
      //}
    

    It is correct to add a space after the comment delimiter, but the lines inside the if control statement must be indented two spaces more compared to if.

      // My uploaded element didn't have a preview array item, so this didn't work
      // if (isset($element['preview'])) {
      //   $output .= '<div class="image-preview">';
      //   $output .= drupal_render($element['preview']);
      //   $output .= '</div>';
      // }
    

    There must be a space between if and the parenthesis.

    +        } else {
    +          daysInnerText = Math.floor(distance / (day));
    +          hoursInnerText = Math.floor((distance % (day)) / (hour));
    +          minutesInnerText = Math.floor((distance % (hour)) / (minute)); secondsInnerText = Math.floor((distance % (minute)) / second);
    +        }

    As shown in Control Structures ā†’ else is put on its own line.
    secondsInnerText = Math.floor((distance % (minute)) / second); must be on a new line.

    -    $description = $values['description_settings']['description'] ?? '';
    -    $old_countdown_image_ids = array();
    -    $current_countdown_image_ids = array();
    -
    +    // $description = $values['description_settings']['description'] ?? '';
    +    // $old_countdown_image_ids = [];
    +    // $current_countdown_image_ids = [];
    

    Code lines that must be deleted, are not commented out.

    -      $file->setPermanent();
    +      /* Load the object of the file by it's fid */
    +      $file = File::load($image_fid);
    

    Inside methods or functions, the used comment delimiter is //. it's is a misspelling for its, the possessive pronoun for it. the object of the file should be the file object.
    I would rather remove that comment, as it is not necessary for $file = File::load($image_fid); which is already clear by itself.

  • Status changed to Needs review over 1 year ago
  • šŸ‡®šŸ‡³India urvashi_vora Madhya Pradesh, India

    Updated the patch.

    As per #9:

    The description is missing a definite article after for.

    The word "for" is added.

    /**
    - * form alter block_delete_form to delete the images used
    - * on the block
    - * @param  [type]             &$form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Implements hook_form_alter().
    + *
    + * Hook used to delete the images used on the block.
      */
    -function gravitas_countdown_form_alter(&$form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_alter(array &$form, FormStateInterface $form_state) {
    For hook implementations, the description starts with Implements followed by the hook name.

    The description is appropriate and starts with "Implements" followed by hook name i.e. hook_form_alter.

    + * Removes the images used on the countdown block
    + * after the block_delete_form form submission.
    + * This submission handler, gravitas_countdown_form_submit,
    + * is added to the block_delete_form form
    + * when the block entity's plugin ID is 'gravitas_countdown'.
    + *
    + * @param array $form
    + *   The form being submitted.
    + * @param \Drupal\Core\Form\FormStateInterface $form_state
    + *   The current state of the form.
      */
    -function gravitas_countdown_form_submit($form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_submit(array $form, FormStateInterface $form_state) {
    The documentation comment for form submission handlers is different from the documentation comments for other functions. API documentation and comment standards / Form-generating functions shows an example of documentation comment for a form validation handler and a forum submission handler.

    Standard first line comment is added, the rest is general description of the submission handler

     /**
    - * @param $content
    + * Retrieves the file IDs associated with the countdown editor content.
    + *
    + * @param string $content
    + *   The content of the countdown editor.
    + *
      * @throws \Drupal\Core\Entity\EntityStorageException
    + *   If there is an error loading the file entities.
    + *
    + * @return array
    + *   An array of file IDs used in the countdown editor.
      */
    As per Drupal API documentation standards for order of documentation sections, the @throws line must be after the @return line.
    @throws: Thrown exceptions says:

    Drupal standards notes: The name of an exception class should appear on the same line as the @throws tag. Put explanations in starting on the next line, but only if they tell you something useful that is not conveyed by the name of the class. If you include an explanation, like other documentation use complete sentences that stand alone, without assuming that "Throws [exception name]" is part of the sentence automatically, since Throws will be a heading when it's displayed on api.drupal.org.

    Repositioned @throws tag after @return.

    -* Implements theme_mymodule_thumb_upload theme callback.
    -*/
    + * Theme function for rendering the thumbnail upload element.
    + *
    + * Renders the HTML output for the thumbnail upload element,
    + * including the image preview and additional widget data.
    + */
     function theme_mymodule_thumb_upload($variables) {
    The (short) description must be a single line and not exceed 80 characters (with the usual exceptions).
    As shown in Themeable functions, the parameter must be described.

    Reverted the original description added by maintainer, the rest information explains the functionality.

       // My uploaded element didn't have a preview array item, so this didn't work
    -  //if (isset($element['preview'])) {
    -  //  $output .= '<div class="image-preview">';
    -  //  $output .= drupal_render($element['preview']);
    -  //  $output .= '</div>';
    -  //}
    -
    -  // If image is uploaded show its thumbnail to the output HTML
    +  // if (isset($element['preview'])) {
    +  // $output .= '<div class="image-preview">';
    +  // $output .= drupal_render($element['preview']);
    +  // $output .= '</div>';
    +  // }
    Even for commented out code, the indentation must be preserved.
    It is correct to add a space after the comment delimiter, but the lines inside the if control statement must be indented two spaces more compared to if.

    Space is added for the lines under "if".

    // My uploaded element didn't have a preview array item, so this didn't work
      // if (isset($element['preview'])) {
      //   $output .= '<div class="image-preview">';
      //   $output .= drupal_render($element['preview']);
      //   $output .= '</div>';
      // }
    There must be a space between if and the parenthesis.

    Unsure of this, as I can see space between "if" and parenthesis. Can you please elaborate this?

    +        } else {
    +          daysInnerText = Math.floor(distance / (day));
    +          hoursInnerText = Math.floor((distance % (day)) / (hour));
    +          minutesInnerText = Math.floor((distance % (hour)) / (minute)); secondsInnerText = Math.floor((distance % (minute)) / second);
    +        }
    As shown in Control Structures else is put on its own line.
    secondsInnerText = Math.floor((distance % (minute)) / second); must be on a new line.

    Moved "else" to a new line and also the "secondsInnerText = Math.floor((distance % (minute)) / second);".

    -    $description = $values['description_settings']['description'] ?? '';
    -    $old_countdown_image_ids = array();
    -    $current_countdown_image_ids = array();
    -
    +    // $description = $values['description_settings']['description'] ?? '';
    +    // $old_countdown_image_ids = [];
    +    // $current_countdown_image_ids = [];
    Code lines that must be deleted, are not commented out.

    No, I can't delete these lines as the module is under active development and these variables are unused variables as of now, but the maintainer might need it, thus commented them to meet the coding standards requirement. However, before removing them, we should ask for the maintainer's permission.

    -      $file->setPermanent();
    +      /* Load the object of the file by it's fid */
    +      $file = File::load($image_fid);
    Inside methods or functions, the used comment delimiter is //. it's is a misspelling for its, the possessive pronoun for it. the object of the file should be the file object.
    I would rather remove that comment, as it is not necessary for $file = File::load($image_fid); which is already clear by itself.

    Removed the comment.

    Do let me know, if you have any more suggestions. Thanks

  • Status changed to Needs work over 1 year ago
  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹
     /**
    - * form alter block_delete_form to delete the images used
    - * on the block
    - * @param  [type]             &$form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Implements hook_form_alter().
    + *
    + * Hook used to delete the images used on the block.
      */
    -function gravitas_countdown_form_alter(&$form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_alter(array &$form, FormStateInterface $form_state) {
       if ($form['#form_id'] == 'block_delete_form') {
    

    Only the short description is used for hook implementations. In the case of hook_form_alter() implementation, the short description must say which form is altered. (That is shown in the last line I quoted.)

    - * submit form callback to remove the images used
    - * on the countdown block
    - * @param  [type]             $form
    - * @param  FormStateInterface $form_state
    - * @return [type]
    + * Form submission handler for block_delete_form().
    + *
    + * Removes the images used on the countdown block
    + * after the block_delete_form form submission.
    + * This submission handler, gravitas_countdown_form_submit,
    + * is added to the block_delete_form form
    + * when the block entity's plugin ID is 'gravitas_countdown'.
    + *
    + * @param array $form
    + *   The form being submitted.
    + * @param \Drupal\Core\Form\FormStateInterface $form_state
    + *   The current state of the form.
      */
    -function gravitas_countdown_form_submit($form, FormStateInterface $form_state)
    -{
    +function gravitas_countdown_form_submit(array $form, FormStateInterface $form_state) {
    

    The short description is correct, except Drupal 8 and higher versions do not implement block_delete_form(). It is better to use the form ID, block_delete_form, already used from the module code.
    The longer description is not used for form submission handlers.
    Parameter descriptions are not given for form submission handlers.

     /**
    -* Implements theme_mymodule_thumb_upload theme callback.
    -*/
    -function theme_mymodule_thumb_upload($variables) {
    + * Implements theme_mymodule_thumb_upload theme callback.
    + *
    + * Renders the HTML output for the thumbnail upload element,
    + * including the image preview and additional widget data.
    + * 
    + * @param array $variables
    + *   An associative array
    + */
    +function theme_mymodule_thumb_upload(array $variables) {

    The correct documentation comment for a theme function is similar to the following one.

    /**
     * Returns HTML for a foo.
     *
     * @param array $variables
     *   An associative array containing:
     *   - foo: The foo object that is being formatted.
     *   - show_bar: TRUE to show the bar component, FALSE to omit it.
     *
     * @ingroup themeable
     */
    function theme_foo($variables) {
    

    The @ingroup line is optional.

    +    // $output .= theme('image_style',
    +    // array(
    +    //   'style_name' => 'thumbnail',
    +    //   'path' => file_load($element['fid']['#value'])->uri,
    +    //   'getsize' => FALSE
    +    // ));.

    Periods are not added to commented out code. phpcs does not parse comments to understand it is commented out code.

  • Assigned to bharath-kondeti
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • šŸ‡®šŸ‡³India bharath-kondeti Hyderabad

    coding-standard-fixes-10.patch. This patch was applied cleanly on 1.1.0. But, there were few dependency injection issues which were not handled.
    Please find updated patch with all changes.

  • Status changed to Needs work over 1 year ago
  • šŸ‡®šŸ‡³India arpitk

    HI @bharath-kondeti the patch #13 it applied cleanly. No more phpcs errors/warnings are produced.
    I ran phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,js . to test.

    Thanks!

  • Status changed to Needs review over 1 year ago
  • Status changed to Needs work 4 months ago
  • Hi @arpitk,

    I applied @bharath-kondeti's patch, it was applied not-so successfully and there are multiple errors reported. Please see below:

    gravitas_countdown git:(main) āœ— curl https://www.drupal.org/files/issues/2023-06-06/3362401-phpcs-fixes-13.patch | patch -p1
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100 29331  100 29331    0     0  75626      0 --:--:-- --:--:-- --:--:-- 78007
    patching file README.md
    patching file gravitas_countdown.info.yml
    Hunk #1 FAILED at 4.
    1 out of 1 hunk FAILED -- saving rejects to file gravitas_countdown.info.yml.rej
    patching file gravitas_countdown.module
    patching file js/gravitas-countdown.js
    patching file src/Plugin/Block/GravitasCountdownBlock.php
    Hunk #1 FAILED at 4.
    Hunk #2 FAILED at 16.
    Hunk #3 succeeded at 131 (offset 44 lines).
    Hunk #4 succeeded at 144 (offset 44 lines).
    Hunk #5 succeeded at 158 (offset 44 lines).
    Hunk #6 succeeded at 212 (offset 44 lines).
    Hunk #7 succeeded at 221 (offset 44 lines).
    Hunk #8 FAILED at 240.
    Hunk #9 FAILED at 261.
    Hunk #10 FAILED at 306.
    Hunk #11 succeeded at 331 (offset 44 lines).
    5 out of 11 hunks FAILED -- saving rejects to file src/Plugin/Block/GravitasCountdownBlock.php.rej
    patching file templates/gravitas-countdown.html.twig
    āžœ  gravitas_countdown git:(main) āœ— cd ..
    āžœ  contrib git:(main) āœ— phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig gravitas_countdown
    
    FILE: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/gravitas_countdown/gravitas_countdown.module
    ----------------------------------------------------------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    ----------------------------------------------------------------------------------------------------------------------------------
     10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Routing\RouteMatchInterface.
    ----------------------------------------------------------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ----------------------------------------------------------------------------------------------------------------------------------
    
    
    FILE: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/gravitas_countdown/gravitas_countdown.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: /Users/PrometInterns/Demo-site/drupal-orgissue/web/modules/contrib/gravitas_countdown/src/Plugin/Block/GravitasCountdownBlock.php
    ---------------------------------------------------------------------------------------------------------------------------------------
    FOUND 55 ERRORS AND 3 WARNINGS AFFECTING 42 LINES
    ---------------------------------------------------------------------------------------------------------------------------------------
       7 | ERROR   | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Form\FormStateInterface.
      22 | ERROR   | [x] Opening brace should be on the same line as the declaration
      38 | ERROR   | [ ] Parameter $configuration is not described in comment
      38 | ERROR   | [ ] Parameter $plugin_id is not described in comment
      38 | ERROR   | [ ] Parameter $plugin_definition is not described in comment
      38 | ERROR   | [ ] Parameter $entity_storage is not described in comment
      41 | ERROR   | [ ] Doc comment for parameter $file_storage does not match actual variable name $date_formatter
      69 | ERROR   | [x] Opening brace should be on the same line as the declaration
     189 | ERROR   | [x] Inline comments must start with a capital letter
     189 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
     193 | WARNING | [ ] Unused variable $key.
     198 | ERROR   | [x] Expected newline after closing brace
     199 | WARNING | [ ] Unused variable $key.
     208 | ERROR   | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines
     210 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
     215 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     216 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 7
     216 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
     217 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 5
     217 | ERROR   | [x] Closing brace indented incorrectly; expected 6 spaces, found 5
     219 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 5
     220 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 5
     221 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 8
     222 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 5
     223 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 6
     225 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 6
     226 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 4
     226 | ERROR   | [x] Closing brace indented incorrectly; expected 5 spaces, found 4
     227 | ERROR   | [x] Line indented incorrectly; expected 4 spaces, found 2
     227 | ERROR   | [x] Closing brace indented incorrectly; expected 4 spaces, found 2
     227 | ERROR   | [x] Expected newline after closing brace
     228 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 4
     228 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
     229 | ERROR   | [x] Line indented incorrectly; expected 4 spaces, found 2
     231 | ERROR   | [x] Line indented incorrectly; expected 4 spaces, found 2
     231 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     232 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 4
     232 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     233 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 5
     234 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 5
     235 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 5
     236 | ERROR   | [x] Line indented incorrectly; expected 10 spaces, found 6
     237 | ERROR   | [x] Line indented incorrectly; expected 10 spaces, found 8
     238 | ERROR   | [x] Line indented incorrectly; expected 10 spaces, found 6
     239 | ERROR   | [x] Line indented incorrectly; expected 8 spaces, found 4
     239 | ERROR   | [x] Closing brace indented incorrectly; expected 5 spaces, found 4
     240 | ERROR   | [x] Line indented incorrectly; expected 6 spaces, found 2
     240 | ERROR   | [x] Closing brace indented incorrectly; expected 4 spaces, found 2
     241 | ERROR   | [x] Line indented incorrectly; expected 4 spaces, found 0
     241 | ERROR   | [x] Closing brace indented incorrectly; expected 2 spaces, found 0
     242 | ERROR   | [x] Line indented incorrectly; expected 2 spaces, found 0
     242 | ERROR   | [x] Closing brace indented incorrectly; expected 2 spaces, found 0
     248 | ERROR   | [x] Opening brace should be on the same line as the declaration
     249 | WARNING | [ ] Unused variable $config.
     259 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     263 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     267 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
     270 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
    ---------------------------------------------------------------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 50 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ---------------------------------------------------------------------------------------------------------------------------------------
    
    Time: 256ms; Memory: 12MB

    Kindly check

    Thanks,
    Jake

  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹

    Let's create a merge request, now that patches are no longer tested.

  • Pipeline finished with Success
    4 months ago
    Total: 134s
    #228679
  • šŸ‡®šŸ‡¹Italy apaderno Brescia, šŸ‡®šŸ‡¹
Production build 0.71.5 2024