[1.0.x] OverlayScrollbars

Created on 19 June 2024, 5 months ago
Updated 5 July 2024, 5 months ago

This module integrates OverlayScrollbars plugin into Drupal and beautifies browser's scrollbar.

It also provides a settings page so the user can define what html elements he wants to have implemented this plugin.
It implements also a permission to manage settings.

Project link

https://www.drupal.org/project/overlayscrollbars →

📌 Task
Status

Fixed

Component

module

Created by

🇵🇹Portugal joao.vilasboas

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @joao.vilasboas
  • 🇮🇳India vishal.kadam Mumbai

    Thank you for applying!

    Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.

    The important notes are the following.

    • If you have not done it yet, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
    • For the time this application is open, only your commits are allowed.
    • The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
    • We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

    To the reviewers

    Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .

    The important notes are the following.

    • It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
    • Reviewers should show the output of a CLI tool → only once per application.
    • It may be best to have the applicant fix things before further review.

    For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .

  • Issue was unassigned.
  • 🇮🇳India vishal.kadam Mumbai
  • Status changed to Needs work 5 months ago
  • 🇮🇳India vishal.kadam Mumbai

    1. Fix phpcs issues.

    phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml overlayscrollbars/
    
    FILE: overlayscrollbars/overlayscrollbars.libraries.yml
    ------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    ------------------------------------------------------------------------------
     27 | ERROR | [x] Expected 1 newline at end of file; 2 found
    ------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ------------------------------------------------------------------------------
    
    FILE: overlayscrollbars/README.md
    ------------------------------------------------------------------------
    FOUND 1 ERROR AND 3 WARNINGS AFFECTING 4 LINES
    ------------------------------------------------------------------------
      3 | WARNING | [ ] Line exceeds 80 characters; contains 111 characters
     18 | WARNING | [ ] Line exceeds 80 characters; contains 82 characters
     19 | WARNING | [ ] Line exceeds 80 characters; contains 116 characters
     25 | ERROR   | [x] Expected 1 newline at end of file; 2 found
    ------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ------------------------------------------------------------------------
    
    FILE: overlayscrollbars/overlayscrollbars.module
    ------------------------------------------------------------------------------
    FOUND 13 ERRORS AND 2 WARNINGS AFFECTING 13 LINES
    ------------------------------------------------------------------------------
     24 | ERROR   | [x] Expected 1 blank line after function; 2 found
     28 | WARNING | [ ] Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
        |         |     xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
     36 | WARNING | [ ] Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
        |         |     xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
     38 | ERROR   | [x] Namespaced classes/interfaces/traits should be referenced with use statements
     39 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
     42 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
     46 | ERROR   | [x] Expected newline after closing brace
     47 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
     49 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
     53 | ERROR   | [x] Expected newline after closing brace
     54 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
     63 | ERROR   | [x] Expected newline after closing brace
     64 | ERROR   | [x] No space found before comment text; expected "// throw $th;" but found "//throw $th;"
     64 | ERROR   | [x] Inline comments must start with a capital letter
     64 | ERROR   | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses
    ------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 13 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ------------------------------------------------------------------------------
    
    FILE: overlayscrollbars/overlayscrollbars.install
    ------------------------------------------------------------------------------
    FOUND 1 ERROR AFFECTING 1 LINE
    ------------------------------------------------------------------------------
     12 | ERROR | [x] Opening brace should be on the same line as the declaration
    ------------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ------------------------------------------------------------------------------

    2. FILE: overlayscrollbars.module

    /**
     * @file
     * Primary module hooks for overlayscrollbars module.
     */

    Drupal does not have primary and secondary hooks. Instead of that, it is preferable to use the usual description: Hook implementations for the [module name] module. where [module name] is the name of the module given in its .info.yml file.

    \Drupal::logger('overlayscrollbars')->error($th->getMessage());

    The first argument passed to logger methods that log a message must be a literal string. Passing a dynamic string is considered a security issue.

  • 🇵🇹Portugal joao.vilasboas

    Thank you for the analysis.
    Just added a code fix to the branch.

  • Status changed to RTBC 5 months ago
  • 🇮🇳India vishal.kadam Mumbai

    Rest looks fine to me.

    Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

  • Assigned to apaderno
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    Thank you for your contribution!
    I updated your account so you can now opt into security advisory coverage for any project you created and every project you will create.

    These are some recommended readings to help you with maintainership:

    You can find more contributors chatting on Slack → or IRC → in #drupal-contribute. So, come hang out and stay involved → !

    Thank you for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review → . I encourage you to learn more about that process and join the group of reviewers.

    I thank also the dedicated reviewers as well.

  • Status changed to Fixed 5 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024