Coding Standard Laravel Package

Product Decisions This Supports

• Standardization of Code Quality: Enables consistent coding standards across PHP/Laravel projects, reducing onboarding friction and technical debt.
• Developer Experience (DX) Improvements: Automates code formatting, linting, and static analysis, allowing engineers to focus on feature development rather than style compliance.
• Scalability for Engineering Teams: Supports CI/CD pipelines with pre-configured rules for PHP-CS-Fixer, PHPStan, and Rector, ensuring uniformity as the team grows.
• Build vs. Buy Decision: Justifies adopting an off-the-shelf solution (vs. custom rules) for teams already using Laravel/PHP, reducing maintenance overhead.
• Roadmap Alignment: Critical for projects targeting PHP 8.0+, PHPUnit 12, or modern tooling like ECS 13.0. Enables future-proofing without reinventing the wheel.
• Use Cases:
  • New Laravel projects needing a baseline standard.
  • Legacy codebases requiring modernization (e.g., PHP 8.5 compatibility).
  • Teams adopting Rector for automated refactoring or PHPStan for static analysis.

When to Consider This Package

• Adopt if:

  • Your team uses Laravel/PHP 8.0+ and lacks a standardized coding style.
  • You prioritize automated code quality (e.g., CI/CD integration for formatting/linting).
  • You’re adopting Rector or PHPStan and need pre-configured rulesets.
  • Your project requires PHPUnit 12+ or Symfony Finder compatibility.
  • You want to reduce manual reviews for style violations (e.g., via php-cs-fixer).

• Look elsewhere if:

  • Your team has custom, non-standard coding rules (e.g., proprietary naming conventions).
  • You’re using PHP < 8.0 (package requires PHP 8.0+).
  • Your project relies on non-PHP/Laravel stacks (e.g., Node.js, Python).
  • You need highly specialized static analysis (e.g., security-focused rules beyond PHPStan’s defaults).
  • Your team prefers manual code reviews over automated tooling.

How to Pitch It (Stakeholders)

For Executives:

"This package standardizes our PHP/Laravel codebase, reducing bugs and onboarding time by automating style enforcement and modernizing legacy code. It integrates seamlessly with our CI/CD pipeline, saving engineering hours on manual reviews—while future-proofing for PHP 8.5 and PHPUnit 12. Think of it as ‘GitHub Copilot for code quality’: less friction, more consistency, and lower technical debt."

For Engineering Teams:

*"Adopting zing/coding-standard gives us:

• One-click compliance: Pre-configured rules for PHP-CS-Fixer, PHPStan, and Rector.
• CI/CD ready: Automatically flags style issues in PRs (e.g., via GitHub Actions).
• Future-proof: Supports PHP 8.5, PHPUnit 12, and modern tooling like ECS 13.0.
• Less busywork: No more arguing about tabs vs. spaces—tools enforce it. Downside: Minimal (MIT license, zero dependents, but actively maintained). Let’s trial it in the dev branch first."*

For Developers:

*"This package lets you:

• Run php-cs-fixer with a single command (composer require zing/coding-standard --dev).
• Auto-fix common issues (e.g., strict booleans, instanceof checks) via Rector.
• Skip manual style reviews—CI will block non-compliant PRs. Example workflow:

composer require zing/coding-standard --dev
./vendor/bin/ecs check src/  # Lints code
./vendor/bin/rector process src/ --dry-run  # Shows refactoring changes
```"
*Pro tip*: Add it to your `composer.json` under `require-dev` and integrate with Git hooks."*