Contrib.social

Improve route name conventions

Open on Drupal.org →
Created on 28 August 2025, 13 days ago

Problem/Motivation

The Date AP Style module's current route names are ugly and don't follow clean naming conventions. Specifically, the route name date_ap_style.date_ap_style_settings is redundant and unnecessarily verbose.

Same for the menu_link id date_ap_style.date_ap_style_settings is overly verbose.

Steps to reproduce

  1. Review current route names in date_ap_style.routing.yml
  2. Observe the redundant date_ap_style.date_ap_style_settings route name
  3. Compare with clean route naming examples from core/contrib

Proposed resolution

  1. Change ugly route name from date_ap_style.date_ap_style_settings to clean date_ap_style.settings
  2. Apply similar cleanup to other redundant route names if they exist
  3. Maintain backwards compatibility by keeping old route as deprecated alias
  4. Add deprecation notice for the old route name
  5. Update all internal references to use clean new route name
  6. Schedule ugly route removal for next major version

Backwards compatibility strategy

Maintain compatibility:

  • Keep existing date_ap_style.date_ap_style_settings route as deprecated alias
  • Add deprecation notice when old route is accessed
  • Provide clear migration path to date_ap_style.settings
  • Remove deprecated route only in next major version (2.0)

Remaining tasks

  • Create new clean date_ap_style.settings route
  • Add deprecation notice for old date_ap_style.date_ap_style_settings route
  • Update internal code to use date_ap_style.settings
  • Update documentation with clean route name
  • Add change record documenting the route cleanup

User interface changes

Settings URL will be cleaner, but old URL will continue to work during deprecation period.

API changes

  • New clean route name date_ap_style.settings will be introduced
  • Old ugly route name date_ap_style.date_ap_style_settings will be deprecated

Data model changes

None.

🌱 Plan
Status

Active

Version

2.0

Component

Code

Created by

🇺🇸United States trackleft2 Tucson, AZ 🇺🇸

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024