Phpcb Laravel Package

Product Decisions This Supports

• Developer Productivity: Reduces manual code review time by visually surfacing violations (e.g., PHP_CodeSniffer/PHPMD) in a browsable format, accelerating onboarding and refactoring.
• Code Quality Enforcement: Enables visual compliance checks for team-specific standards (e.g., PSR-12, Laravel conventions) without relying on IDE plugins or heavyweight tools like SonarQube.
• CI/CD Enhancement: Transforms static analysis from text-based logs to interactive reports, making it easier to block PRs with violations (e.g., GitHub Branch Protection rules).
• Legacy Code Modernization: Identifies technical debt clusters in monolithic PHP/Laravel apps by highlighting low-quality code sections, prioritizing refactoring efforts.
• Build vs. Buy: Justifies a lightweight, open-source alternative to commercial tools for teams with limited budgets, especially if PHP_CodeSniffer/PHPMD are already in use.
• Roadmap Prioritization:
  • Short-term: Integrate into CI/CD for immediate feedback loops.
  • Mid-term: Embed reports in a custom Laravel dashboard (e.g., Laravel Nova) for centralized visibility.
  • Long-term: Replace with a maintained fork or migrate to modern tools (e.g., PHPStan + custom visualizer) if the package becomes obsolete.

When to Consider This Package

Adopt If:

• Your team uses PHP_CodeSniffer or PHPMD but lacks a browsable, integrated way to visualize violations (e.g., no IDE plugins, no SonarQube).
• You need a low-overhead solution for manual code reviews, onboarding, or legacy code analysis—no server setup required.
• Your workflow includes gating PRs based on code quality, and you want visual feedback (not just CLI output).
• You’re working with Laravel or monolithic PHP apps where modular tooling (e.g., Pest, PHPStan) isn’t yet adopted.
• You prioritize open-source flexibility over vendor lock-in, even if the package is archived (forkable).

Look Elsewhere If:

• You require real-time IDE integration (e.g., VSCode/PHPStorm plugins like PHP Intelephense or SonarLint).
• Your team needs advanced metrics (e.g., cyclomatic complexity, test coverage) beyond static analysis (consider SonarQube, PHPStan, or Pest).
• You’re using modern PHP frameworks (e.g., Symfony, Lumen) with built-in tooling (e.g., Symfony Panther for testing, PHPStan for static analysis).
• You need active maintenance—this package is archived; evaluate the effort to fork or maintain it in-house.
• Your codebase is small or greenfield, where manual reviews or simpler tools (e.g., php -l for syntax checks) suffice.

How to Pitch It (Stakeholders)

For Executives:

*"This package turns static code analysis into actionable, visual insights—like a 'code health' heatmap—helping developers spot violations (e.g., PSR-12 errors, security risks) at a glance. For a fraction of the cost of tools like SonarQube, it integrates seamlessly with our existing QA workflows (PHP_CodeSniffer/PHPMD) to:

• Reduce bugs by catching issues early.
• Improve onboarding with clear visual cues for new hires.
• Enforce consistency without heavy tooling overhead.

Ideal for teams needing a lightweight, open-source solution to modernize legacy PHP/Laravel codebases or accelerate PR reviews. The tradeoff? It’s archived, but we can fork it or replace it later if needed."*

For Engineering:

*"PHP_CodeBrowser generates a browsable HTML report of your PHP codebase, highlighting sections flagged by QA tools like PHP_CodeSniffer or PHPMD. Here’s how it fits Laravel:

• Saves time: Replaces manual grep/vi for violation hunting with a clickable code map.
• Works with Laravel:
  • Run via Artisan commands (e.g., php artisan code:browser).
  • Integrate into CI/CD (e.g., GitHub Actions) to block PRs with violations.
  • Serve reports via a custom route (e.g., /phpcb) or embed in Nova.
• Tradeoffs:
  • Archived repo: Forkable, but no active updates.
  • Best for: Teams already using PHP_CodeSniffer/PHPMD; not a replacement for IDE plugins or advanced metrics.
  • Performance: Heavy for large codebases—mitigate with incremental analysis or queued workers.

Example workflow:

1. Run php artisan code:browser after phpcs in CI.
2. Upload the HTML report as a PR artifact.
3. New devs click through violations to see exactly where to fix issues.

Alternatives: If you need real-time IDE feedback, consider PHPStan + VSCode extensions. For metrics, SonarQube is more robust but heavier."*

For QA/DevOps:

*"This tool bridges the gap between static analysis and developer experience by making violations visually obvious. Key use cases:

• Onboarding: Highlight 'risky' code sections for new hires.
• Refactoring: Identify technical debt in legacy Laravel apps.
• Compliance: Enforce team standards (e.g., PSR-12) with color-coded feedback.

How to adopt:

1. Add covex-nn/phpcb to composer.json.
2. Configure PHP_CodeSniffer/PHPMD rulesets (e.g., .phpcs.xml).
3. Run in CI:

   composer require covex-nn/phpcb
   ./vendor/bin/phpcb ./app --sniffer-report=sniffer.xml
   

4. Serve the phpcb_output/ directory via a Laravel route or upload as a CI artifact.

Pro tip: Pair with GitHub Branch Protection to require passing phpcb reports for PRs."*