Contrib.social

Question: Can I rename "Report" plugins to "Checklist" plugins?

Open on Drupal.org →
Created on 27 February 2023, over 1 year ago

Problem/Motivation

I created the 4.x branch for 2 main features: Saving reports and sending reports.

I created a new Drupal Entity called "Report" which stores the entire Site Audit output in the database.

There's now confusion in the naming of things. Up until now, the "SiteAuditReport" plugins referred to an individual report, like BestPractices or Cache.

To me, calling the saved entities "reports" makes sense. I think we should refactor "SiteAuditReportBase" into a name that reflects it's purpose: to group checks together in a category.

Proposed resolution

Rename "SiteAuditReport*" things to "SiteAuditChecklist*".

Remaining tasks

  1. SiteAuditReportBase
  2. SiteAuditReportInterface
  3. SiteAuditReportManager
  4. SiteAuditReport Annotation
  5. SiteAuditReport Plugins.

We would also have to notify any contrib to change their plugins, or we could supply a patch for them. Does Drupal Rector allow us to provide deprecation fixes for Drupal 10?

User interface changes

Very few. 4.x UI is still under development so any needed changes can be made there.

API changes

Any modules creating SiteAuditReport plugins would have to change them to be SiteAuditChecklist plugins.

Data model changes

None. Site Audit doesn't yet have a data model.

🌱 Plan
Status

Active

Version

4.0

Component

Code

Created by

🇺🇸United States Jon Pugh Newburgh, NY

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

Comments & Activities

  • Issue created by @Jon Pugh
  • Comment over 1 year ago →
    🇺🇸United States Jon Pugh Newburgh, NY

    Coincidentally, security_review module already uses "Checklist", so this lines up nicely.

    /** @var \Drupal\security_review\Checklist $checklist */
    $checklist = Drupal::service('security_review.checklist');

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024