As kint-php/kint support is being removed from devel in an upcoming release I've taken over the abandoned kint module and rewritten it from scratch.

This adds some simple UI configuration, permissions based dump enabling, a devel dumper plugin, and general drupal integrations for performance and visibility.

Reviewers will then examine the project files and provide feedback over the coming days/weeks

Well if you're offering I'll go ahead and ask some questions then:

  1. drupal/kint is apparently reserved by a defunct submodule of a very old version of devel, forcing the package name to drupal/kint-kint. Is there a way to resolve this?
  2. Since I implement a plugin for another module phpstan needs a bit of help to find it. mglaman/phpstan-drupal doesn't work locally since drupal core is in vendor. I can use scanDirectories to get phpstan working locally, but then it breaks in CI. How do I handle this so I can use it both locally and in CI without changes?

Project link

https://www.drupal.org/project/kint

Comments

jnvsor created an issue. See original summary.

vishal.kadam’s picture

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.

vishal.kadam’s picture

Title: [2.x] kint » [2.x] Kint
Issue summary: View changes
vishal.kadam’s picture

Status: Needs review » Needs work

1. FILE: src/Plugin/Devel/Dumper/DevelDumper.php

  /**
   * {@inheritdoc}
   */
  public function __construct(protected Config $kintConfig, array $configuration, $plugin_id, $plugin_definition) {

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

2. FILE: kint.links.menu.yml

# devel.admin_settings_link:
#   title: 'Devel settings'
#   description: 'Helper functions, pages, and blocks to assist Drupal developers. The devel blocks can be managed via the block administration page.'
#   route_name: devel.admin_settings
#   menu_name: devel

Remove commented code.

jnvsor’s picture

Status: Needs work » Needs review

The 2 mentioned issues are now fixed on the 2.x branch. I've also raised the phpstan level to max, so the refactors from that may have resulted in some new issues cropping up.

Notably phpstan ignored @inheritdoc but phpcs required all parameters to be present once you add a single @param so I had to copy paste a bunch of core docblocks.

vishal.kadam’s picture

Status: Needs review » Needs work

FILE: README.md

The README file is missing the required sections, including Requirements, and Installation.

jnvsor’s picture

Status: Needs work » Needs review

Readme updated, hook_help implemented

vishal.kadam’s picture

Status: Needs review » Needs work

wip-test is a wrong name for a branch. Release branch names always end with the literal .x as described in Release branches. The only exception is for the main branch, which is actually not fully supported on drupal.org and should be avoided.

jnvsor’s picture

Status: Needs work » Needs review

That's because it's not a release branch. It's there so I can do a CI check before pushing to 2.x without having to make a PR every time. Or is there a rule that only release branches are allowed in drupal repos?

vishal.kadam’s picture

No, there is no restriction that limits Drupal repositories to only having release branches.

vishal.kadam’s picture

Rest seems fine to me.

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

avpaderno’s picture

Assigned: Unassigned » avpaderno
Status: Needs review » Reviewed & tested by the community

Thank you for your contribution and for your patience with the review process!

I am going to update your account so you can opt into security advisory coverage any project you create, including the projects you already created.

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!
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 the dedicated reviewers as well.

avpaderno’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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