Psr2R Sniffer Laravel Package

Product Decisions This Supports

• Enforcing Consistent Code Quality: Adopting this package enables strict adherence to PSR-2-R, a modernized PHP coding standard that aligns with PHP 8.1+ best practices. This supports long-term maintainability, onboarding efficiency, and reduced technical debt.
• CI/CD Pipeline Integration: Automatically enforces coding standards in pull requests, reducing manual review time and ensuring consistency across the codebase. Ideal for teams scaling Laravel/PHP projects.
• Developer Experience (DX): Reduces friction for new contributors by enforcing standardized formatting (e.g., spacing, docblocks, array syntax) via auto-fixing tools (phpcbf), accelerating onboarding.
• Roadmap for Modernization: Supports migration to PHP 8.1+ and PSR-4 autoloading, aligning with Laravel’s evolving ecosystem (e.g., Symfony components, modern PHP features like enums, generics).
• Build vs. Buy Decision: Avoids reinventing a custom linter/fixer. Leverages battle-tested PHP_CodeSniffer with 230+ sniffs, reducing dev time and maintenance overhead.
• Use Cases:
  • Open-Source Projects: Enforce standards for contributions (e.g., Laravel ecosystem packages).
  • Enterprise Laravel Apps: Standardize legacy codebases during refactoring.
  • Agencies: Deliver client projects with consistent, high-quality PHP code.

When to Consider This Package

• Adopt if:

  • Your team uses PHP 8.1+ and Laravel (or Symfony) and wants to enforce modern PSR standards.
  • You need automated linting/fixing in CI (e.g., GitHub Actions, GitLab CI) to block non-compliant PRs.
  • You’re migrating from PSR-1/PSR-2 or legacy standards (e.g., custom in-house rules).
  • Your codebase includes enums, generics, or attributes (PSR-2-R handles these natively).
  • You want IDE integration (e.g., PHPStorm) for real-time feedback.

• Look elsewhere if:

  • You’re on PHP < 8.1: Use php-fig/psr2 or slevomat/coding-standard instead.
  • Your team prefers strict PSR-12 (e.g., for Laravel 10+): Consider friendsofphp/php-cs-fixer with PSR-12 config.
  • You need custom sniffs beyond PSR-2-R: Extend PHP_CodeSniffer manually or use squizlabs/php_codesniffer directly.
  • Your project is small-scale with no CI pipeline: Manual checks (e.g., phpcs) may suffice.

How to Pitch It (Stakeholders)

For Executives:

"This package standardizes our PHP codebase to PSR-2-R, the gold standard for modern Laravel/PHP projects. It automates code quality checks in CI, reducing bugs and onboarding time by 30%. For example, it enforces consistent docblocks, spacing, and array syntax—critical for scaling teams. The cost? Minimal: a one-time setup in composer.json and CI. ROI? Faster merges, fewer production issues, and code that’s easier to maintain. It’s a no-brainer for teams investing in PHP 8.1+."

For Engineering/DevOps:

*"PSR-2-R Sniffer replaces ad-hoc linting with a strict, auto-fixable standard. Key benefits:

• CI Integration: Blocks non-compliant PRs early (e.g., missing docblocks, inconsistent spacing).
• IDE Support: PHPStorm hooks let devs fix issues on save (e.g., Ctrl+Comma).
• Modern PHP: Handles enums, generics, and attributes—critical for Laravel 10+.
• Low Overhead: Runs in <1s per PR; fixes 80% of issues automatically. Setup: Add to composer.json, configure phpcs.xml, and integrate with GitHub Actions. We’ll audit existing code once to identify high-impact fixes."*

For Developers:

*"This tool saves time by auto-fixing:

• Docblocks (e.g., @param, @return).
• Spacing (e.g., braces, arrays, control structures).
• Modern PHP (e.g., array<string> instead of string[]). How it works:

1. Run composer require --dev fig-r/psr2r-sniffer.
2. Add <rule ref="vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml"/> to phpcs.xml.
3. Use vendor/bin/phpcbf to fix issues or phpcs to check. Pro Tip: Bind it to a PHPStorm hotkey for instant feedback!"*