Php Conventions Laravel Package

Product Decisions This Supports

• Standardization & Consistency: Enables enforcement of coding conventions (e.g., PSR-12, custom team standards) across PHP/Laravel projects, reducing onboarding friction and code review overhead.
• Developer Experience (DX): Automates repetitive style checks (e.g., indentation, naming, docblocks), freeing engineers to focus on business logic.
• Build vs. Buy: Justifies buying this lightweight package over custom scripts or manual linting, especially for teams already using PHPStan/Pint.
• Roadmap Alignment: Supports initiatives like:
  • Scaling Laravel monorepos with shared conventions.
  • Migrating legacy PHP codebases to modern standards.
  • Enabling "shift-left" quality checks in CI/CD pipelines.
• Use Cases:
  • Pre-commit hooks to block non-compliant code.
  • Onboarding new hires with automated style enforcement.
  • Auditing third-party Laravel packages for convention compliance.

When to Consider This Package

• Adopt if:
  • Your team prioritizes consistency over flexibility (e.g., strict PSR-12 adherence).
  • You lack budget/time to maintain custom linting tools (e.g., no PHP-CS-Fixer/Pint).
  • Your project is Laravel-centric and needs PHP-specific conventions (e.g., Eloquent naming, Blade templates).
  • You’re early-stage and want low-maintenance tooling (1-star package with minimal dependencies).
• Look elsewhere if:
  • You need customizable rules (e.g., team-specific naming conventions) → Use PHP-CS-Fixer or Pint.
  • Your stack is multi-language (e.g., JS/TS/Python) → Consider ESLint, Black.
  • You require active maintenance (last release: 2022) → Evaluate Laravel Pint (official Laravel solution).
  • Your team prefers self-hosted solutions (e.g., SonarQube) for deeper analysis.

How to Pitch It (Stakeholders)

For Executives: "This package lets us enforce PHP coding standards automatically—like a spellcheck for our codebase. For $0 cost, it reduces busywork for engineers (e.g., manual style fixes) and ensures consistency across our Laravel apps. Think of it as a ‘guardrail’ for quality, catching issues early in development. Since it’s lightweight and integrates with Git hooks, it won’t disrupt workflows but will pay dividends in maintainability."

For Engineering: "We’re adding a pre-commit hook using ecphp/php-conventions to block non-compliant PHP/Laravel code (e.g., inconsistent indentation, missing docblocks). It’s a drop-in replacement for manual linting and plays nicely with Laravel’s ecosystem. No new dependencies beyond PHP 8.0+—just run composer require ecphp/php-conventions and configure it in .php-conventions.php. Pros: Faster reviews, fewer style debates. Cons: Limited customization (but we can extend rules later if needed).* Alternatives: Pint or PHP-CS-Fixer, but this is simpler for our current needs."*