Coding Standard Laravel Package

Product Decisions This Supports

• Enforce engineering best practices: Adopt stricter PHP coding standards to reduce technical debt, improve maintainability, and align with modern Laravel/PHP conventions (e.g., constructor property promotion, enum handling, and cognitive complexity limits).
• Developer experience (DX) improvements: Automate code formatting and linting to reduce manual review cycles, enabling engineers to focus on feature development. Supports CI/CD integration for pre-commit hooks or PR checks.
• Onboarding acceleration: Standardize code style and structure, reducing ramp-up time for new hires by eliminating ambiguity in formatting/naming conventions.
• Security and reliability: Enforce functional sniffs (e.g., disallowing null-safe operators, Yoda comparisons) to mitigate common vulnerabilities and edge-case bugs.
• Roadmap alignment: Justify investment in PHP 8.x features (e.g., attributes, enums) by enforcing consistent usage patterns via this package.
• Build vs. buy: Avoid reinventing a custom linting solution; leverage this battle-tested, community-maintained standard to save dev time and ensure consistency across open-source contributions or vendor packages.

When to Consider This Package

• Adopt if:
  • Your team uses Laravel/PHP and lacks a standardized coding style guide.
  • You prioritize maintainability over developer autonomy in formatting.
  • Your CI/CD pipeline needs automated enforcement of code quality (e.g., blocking PRs with violations).
  • You’re migrating to PHP 8.x and need to enforce modern syntax rules (attributes, enums, null coalescing).
  • Your codebase has high churn or distributed teams requiring consistency.
• Look elsewhere if:
  • Your team values flexibility in style (e.g., PSR-12 alone suffices).
  • You’re using a strict framework-specific standard (e.g., Symfony’s) that conflicts with Slevomat’s rules.
  • Your codebase is small or greenfield with no legacy debt to refactor.
  • You lack CI/CD infrastructure to integrate static analysis tools.

How to Pitch It (Stakeholders)

For Executives: "This package lets us automate 80% of our code review effort by enforcing consistent, high-quality PHP standards—reducing bugs, speeding up onboarding, and aligning with modern Laravel best practices. It’s a low-cost, high-impact way to improve developer productivity and code reliability, with minimal upfront effort (just integrate into CI). Think of it as ‘GitHub Copilot for code quality.’"

For Engineering Leaders: "Slevomat’s sniffs cover three critical areas: safety (e.g., blocking null-safe operators that cause runtime errors), cleanliness (dead code detection), and consistency (formatting, naming). It plays well with PHP_CodeSniffer and can auto-fix many issues, cutting manual refactoring time. We can start with a subset of rules (e.g., formatting + safety) and expand later. It’s also vendor-neutral, so it won’t lock us into proprietary tools."

For Developers: *"This will save you time by:

1. Auto-fixing common formatting issues (e.g., bracket placement, spacing).
2. Catching anti-patterns early (e.g., Yoda comparisons, cognitive complexity).
3. Reducing bikeshedding in PRs—no more debates over ‘trailing commas’ or ‘enum spacing.’ We’ll configure it to match our team’s preferences and phase it in gradually. Think of it as a ‘linter on steroids’ that makes your code more maintainable with less effort."*