[1.0.x] Markdownify

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 → .

Fix phpcs issues.

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

FILE: markdownify/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 17 WARNINGS AFFECTING 17 LINES
----------------------------------------------------------------------
   3 | WARNING | Line exceeds 80 characters; contains 334 characters
  26 | WARNING | Line exceeds 80 characters; contains 88 characters
  28 | WARNING | Line exceeds 80 characters; contains 210 characters
  29 | WARNING | Line exceeds 80 characters; contains 123 characters
  30 | WARNING | Line exceeds 80 characters; contains 161 characters
  31 | WARNING | Line exceeds 80 characters; contains 141 characters
  58 | WARNING | Line exceeds 80 characters; contains 141 characters
  64 | WARNING | Line exceeds 80 characters; contains 160 characters
  68 | WARNING | Line exceeds 80 characters; contains 162 characters
  76 | WARNING | Line exceeds 80 characters; contains 139 characters
  77 | WARNING | Line exceeds 80 characters; contains 159 characters
  78 | WARNING | Line exceeds 80 characters; contains 165 characters
  84 | WARNING | Line exceeds 80 characters; contains 200 characters
 112 | WARNING | Line exceeds 80 characters; contains 100 characters
 164 | WARNING | Line exceeds 80 characters; contains 87 characters
 166 | WARNING | Line exceeds 80 characters; contains 96 characters
 174 | WARNING | Line exceeds 80 characters; contains 82 characters
----------------------------------------------------------------------

FILE: markdownify/src/Service/MarkdownifyEntityRenderer.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 6 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Entity\EntityInterface.
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

FILE: markdownify/src/Controller/MarkdownifyController.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Symfony\Component\DependencyInjection\ContainerInterface.
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

Hi vishal.kadam,

Thank you so much for taking the time to review my application and my module’s codebase. I’ve fixed the PHPCS errors you flagged, and the module is now ready for review again.

I also wanted to share some ideas that might help make the review process smoother and more transparent for everyone.

1. Reviewer using outdated drupal/coder version with obsolete sniff rules:

It seems you are using an older version of the drupal/coder module ( 8.3.24 → ), which is nearly one year old. This version includes a rule to check and fix the order of use statements. However, this rule was removed in 8.3.26 → (see #3483028 📌 Revert case sensitive use-statement sniff Active ).

The current coding standards don’t enforce any specific order for use statements ( #1624564 📌 Coding standards for "use" statements RTBC ), and the official documentation → confirms this:

"If there are more than one classes to 'use', there is no specific rule to order them."

To accurately reproduce the errors you reported, I had to downgrade my drupal/coder module from version 8.3.28 to 8.3.24.

To avoid unnecessary errors and confusion, I’d recommend updating to the latest version of drupal/coder during reviews. It ensures that reviews align with the most up-to-date coding standards and avoids issues caused by outdated sniffs.

2. Improving transparency in PHPCS guidelines:

The Application checklist guidelines → currently advise running:

"Before opening an application, please check the issues reported by phpcs --standard=Drupal,DrupalPractice for the project and fix everything that needs to be fixed."

I followed these instructions carefully and ensured my code was error-free before submitting. However, it seems reviewers is using additional flags in the command, configurations, or even an older version of drupal/coder. This difference can lead to mismatches in results and confusion about what’s expected.

Would it make sense to update the application documentation to include:

1. The exact phpcs command (with flags) used by reviewers.
2. The specific version of drupal/coder required for the review.

This small tweak could ensure everyone is using the same tools and settings, making the process more consistent and predictable. If this idea resonates, I’d be happy to help update the documentation or provide input to make it clearer for future applicants.

Thank you again for your time and effort. I truly appreciate the care and detail you bring to this process. Let me know if there’s anything else I can do to assist!

Now that GitLab CI is available to all the projects, it is better to enable it by adding a .gitlab-ci.yml file copied from the template file available in the Git Templates repository as described in GitLab CI → .

The documentation for reviewers already contains the following text.

Since GitLab CI is now enabled for all the projects, it would be better to use for these tools the same configuration files used by GitLab CI, which are stored in the GitLab Templates repository.

I will update the part for the applicants too.

@avpaderno Thanks for the great recommendation! GitLab CI is now running on the project, and everything is passing on green. 🚀

I will review the project tomorrow.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/Controller/MarkdownifyController.php

Since that class does not use any method from the parent class, it does not need to use ControllerBase as parent class. Controllers do not need to have a parent class; as long as they implement \Drupal\Core\DependencyInjection\ContainerInjectionInterface, they are fine.

modules/views/src/Controller/MarkdownifyViewPageController.php

The class is not part of the public API and cannot be used as parent class for classes implemented by a contributed module. Only base classes can be used as parent class.