spatie/laravel-error-solutions

Display solutions on the Laravel error page

Fund package maintenance!
Spatie

1.0.1 2024-11-07 13:41 UTC

This package is auto-updated.

Last update: 2024-12-07 13:48:52 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package can display solutions on the Laravel error page. Here's how it looks:

image

For some solutions, the package will display a button that will automatically run the solution. Here's how that looks when you forget to set an APP_KEY in your .env file:

image

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require --dev spatie/laravel-error-solutions

You can publish the config file with:

php artisan vendor:publish --tag="error-solutions-config"

This is the contents of the published config file:

return [
    /**
     * Display solutions on the error page
     */
    'enabled' => true,

    /**
     * Enable or disable runnable solutions.
     *
     * Runnable solutions will only work in local development environments,
     * even if this flag is set to true.
     */
    'enable_runnable_solutions' => true,

    /**
     * This class is responsible for determining if a solution is runnable.
     *
     * In most cases, you can use the default implementation.
     */
    'runnable_solutions_guard' => Spatie\LaravelErrorSolutions\Support\RunnableSolutionsGuard::class,
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="error-solutions-views"

Usage

You can find full documentation on how to use this package on our documentation site.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.