Symfony Quality Cockpit

Reusable Symfony bundle for presenting PHPUnit, Infection, PhpMetrics, Deptrac and Composer Audit reports in one development dashboard.

Status

The package is being extracted from the Repair Workshop prototype. The extraction audit and target architecture are documented in the source project before application code is ported.

Installation

composer require --dev chrisdev/symfony-quality-cockpit

Register the bundle when Symfony Flex is not configured for the package:

Chrisdev\QualityCockpit\QualityCockpitBundle::class => ['dev' => true, 'test' => true],

Import the routes:

quality_cockpit:
    resource: '@QualityCockpitBundle/config/routes.php'

Configure the report root:

quality_cockpit:
    reports:
        base_directory: '%kernel.project_dir%/var/reports'

Compatibility currently follows the extracted source environment: PHP 8.4 and Symfony 7.4 or 8.0. The Symfony 7.4 path remains to be verified in CI before it is advertised as supported.

Frontend integration

The bundle ships Tailwind classes in its Twig templates and Stimulus controllers for the tabs and Infection filters. With Tailwind CLI and a custom JavaScript entrypoint, add the bundle templates to the host scan and register its controllers:

@source "../../vendor/chrisdev/symfony-quality-cockpit/templates/**/*.twig";

import QualityTabsController from '../vendor/chrisdev/symfony-quality-cockpit/assets/controllers/quality_tabs_controller.js';
import InfectionFiltersController from '../vendor/chrisdev/symfony-quality-cockpit/assets/controllers/infection_filters_controller.js';

app.register('quality-tabs', QualityTabsController);
app.register('infection-filters', InfectionFiltersController);