snicco/debug-bundle

v2.0.0-beta.9 2024-09-07 14:27 UTC

README

codecov Psalm Type-Coverage Psalm level PhpMetrics - Static Analysis PHP-Versions

This WordPress bundle can be used together with the snicco/http-routing-bundle in applications based on snicco/kernel.

The DebugBundle configures Whoops as the error handler for the middleware pipeline of your application.

This bundle should never be used in production.

Installation

composer install snicco/debug-bundle

Configuration

See config/debug.php for the available configuration options.

If this file does not exist in your configuration directory the default configuration will be copied the first time the kernel is booted in dev mode.

Usage

Add the DebugBundle to your bundles.php config file in the DEV environment.

<?php
// /path/to/configuration/bundles.php

use Snicco\Bundle\Debug\DebugBundle;

return [
    
    'bundles' => [
        Snicco\Component\Kernel\ValueObject\Environment::DEV => [
           DebugBundle::class
        ]   
    ]   
];

If the kernel environment is Environment::dev() the whoops error handler will automatically be used.

To disable the whoops error handler set the kernel env to Environment::dev(false) (Passing false as a second argument means "no debug").

Contributing

This repository is a read-only split of the development repo of the Snicco project.

This is how you can contribute.

Reporting issues and sending pull requests

Please report issues in the Snicco monorepo.

Security

If you discover a security vulnerability within BetterWPCache, please follow our disclosure procedure.