Rector Laravel Package

Product Decisions This Supports

• Code Modernization & Maintenance: Accelerates legacy Contao (CMS) codebase upgrades by automating refactoring tasks (e.g., PHP 7.4+ compatibility, PSR-12 compliance) via Rector rules. Reduces manual effort in migrating to newer PHP versions or Contao releases.
• Developer Productivity: Enables teams to enforce consistent coding standards and reduce technical debt without manual code reviews or manual refactoring. Integrates seamlessly into CI/CD pipelines (e.g., GitHub Actions) to auto-fix issues pre-merge.
• Cost Efficiency: Avoids hiring specialized refactoring consultants or outsourcing by automating repetitive, rule-based changes. Lowers long-term maintenance costs for Contao-based projects.
• Roadmap Alignment: Supports a "shift-left" strategy by catching refactoring needs early in development, aligning with goals like:
  • Migrating from PHP 7.x to 8.x.
  • Adopting Contao 5.x features while maintaining backward compatibility.
  • Preparing for headless Contao or API-first initiatives.
• Build vs. Buy: Justifies buying this package over custom scripts or manual processes if the team lacks Rector expertise. For teams already using Rector, this provides Contao-specific presets to avoid reinventing rules.

When to Consider This Package

• Adopt if:

  • Your project uses Contao CMS (v4.x or v5.x) and relies on PHP 7.4+ or plans to upgrade.
  • You need to refactor legacy code at scale (e.g., replacing deprecated functions, updating namespaces, or enforcing PSR standards).
  • Your team uses Rector or is open to adopting it for automated refactoring.
  • You want to integrate refactoring into CI/CD (e.g., fail builds on non-compliant code or auto-fix pre-commit).
  • You lack dedicated time/resources for manual refactoring but have technical debt in Contao’s core or custom extensions.

• Look elsewhere if:

  • Your codebase is trivial or already modern (no urgent refactoring needs).
  • You’re not using Contao (this package is Contao-specific; generic Rector rules may suffice).
  • Your team resists tooling or lacks PHP/Rector familiarity (requires setup and learning curve).
  • You need custom business logic refactoring (Rector handles syntax/structure, not semantic changes).
  • You’re using Contao 3.x (limited compatibility; focus on manual upgrades or third-party tools).

How to Pitch It (Stakeholders)

For Executives/Business Leaders: "This package lets us modernize our Contao CMS codebase automatically—saving months of manual work and reducing risks from outdated PHP or deprecated Contao features. By integrating it into our development pipeline, we’ll catch issues early, cut maintenance costs, and future-proof our system for upgrades like PHP 8.x or headless Contao. It’s a low-risk investment with high ROI, especially if we’re already using tools like Rector or GitHub Actions."

For Engineering Teams: *"contao/rector gives us Contao-specific Rector rules to automate tedious refactoring—think replacing tl_* database functions with Doctrine queries, updating namespaces, or enforcing PSR-12. It’s like a ‘find-and-replace on steroids’ for large codebases. We can:

• Run it locally to preview changes before committing.
• Add it to CI to block non-compliant code or auto-fix it.
• Customize rules for our project’s needs (e.g., legacy Contao extensions). It’s a force-multiplier for cleaning up tech debt without writing custom scripts."*

For Developers: *"If you’ve ever dreaded upgrading Contao or PHP because of manual refactoring, this package automates the boring stuff. Example use cases:

• PHP 8.0+ migration: Auto-convert foreach with &$value to typed properties.
• Contao 5.x: Replace Widget classes with new ContentElement patterns.
• PSR-12: Standardize imports, class names, and method separators. It’s dead simple to set up—just add a config file and run rector process. Want to see it in action? I’ll demo how it handles [specific pain point] in our codebase."*