Convert HelpSection plugin discovery to attributes

Amber Himes Matz → made their first commit to this issue’s fork.

I took a stab at this.

Looks like I missed some coding standards. I'll take a closer look tomorrow if I can. Happy to have help though.

Thanks for the review, @larowlan! I think I addressed everything, though there was 1 point of confusion about line 29 of core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php, which I asked about in GitLab.

Appears to have some failures.

I'm working on this again. When I try to install Drupal 11.x-dev with this code running, the installation is failing with a typehint error in this new code.

TypeError: Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery::__construct(): Argument #4 ($annotation_namespaces) must be of type array, string given, called in /var/www/html/core/lib/Drupal/Core/Plugin/DefaultPluginManager.php on line 305 in Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery->__construct() (line 56 of core/lib/Drupal/Core/Plugin/Discovery/AnnotatedClassDiscovery.php).

After fixing this, I will test the HelpSection in the UI to make sure it's working and upload a screenshot of that.

There was a missing use statement for the HelpSection attribute class in HelpSectionManager.php. Adding this fixed the error on installation (because it fixed the value of the HelpSection::class parameter passed in the parent constructor, which was meaningless without the use Drupal\help\Attribute\HelpSection; statement.

I tested this on a successfully-installed 11.x-dev site and verified that HelpSection plugins displayed as expected on admin/help. Screenshot attached with HelpSection plugins provided by Help module highlighted.

I glanced at MR and see that the test HelpSection plugins still need to be converted.

Thanks @quietone for the reminder! I am working on this now.

Also, I updated the IS with remaining tasks (and those already done).

This is ready for review.

I've converted the 2 test plugins, EmptyHelpSection and TestHelpSection to use the HelpSection attribute.

And I removed a trailing comma from the last item in the attribute HelpTopicSection. I guess we're not doing trailing commas for last items in these arrays in attributes? Yet, anyway. I think that code standards for these are still pending (that's my current understanding). Regardless, this makes everything consistent and is consistent with the Action example as well.

Updated remaining tasks in issue summary (all tasks done).

See that all @HelpSection have been replaced and tests appear to be passing.

Applying locally I can still use help module just fine

+1 from me but will leave in review for additional eyes.

Re-reviewed and appears all feedback has been addressed.

+1 RTBC, just added declare(strict_types=1); to new class and rebased

This is missing deriver support per 📌 Add an assert that ensures all attribute plugins support derivers Needs review

Fixed #21

@andypost mind taking a look at the phpcs error? Can review after.

Fixed, sorry

Still blows my mind you can make that change and few minutes later tests are done.

Feedback has been addressed.

Thanks!

Updated issue summary’s remaining tasks about adding the optional deriver argument, and crossed it off to show that we’ve completed it.

I went through all unresolved threads and double-checked that they were resolved, and resolved them.

Committed and pushed b9dfd470e3 to 11.x and c57ce025c3 to 10.3.x. Thanks!

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