Laravel Config Checker Package

Sep 26, 2024 106 stars by Eric L. Barnes

Package to check that configuration key references actually exist in your config files.

Check for undefined configuration key references in your Laravel project.

This package adds an Artisan command to check for invalid configuration file references in your application code and Blade views.

Support me

Feel like shouting out a thank you? Buy me a coffee! ☕️

Installation

You can install the package via composer:

composer require chrisdicarlo/laravel-config-checker

After installing the package, you can publish the configuration file:

php artisan vendor:publish --tag="config-checker-config"

Usage

From the command-line, simply run:

php artisan config:check

The command will scan your Php code under app, database, routes, bootstrap and your Blade views under resources/views.
Any errors will be displayed in a table with information on the location and missing reference:

Sample Output

Customizing paths

If you want the command to scan PHP/Blade code under custom paths, you can add or update entries in config/config-checker.php.

Disabling progress

To disable progress bars (e.g. in CI), pass the --no-progress flag when running the command:

php artisan config:check --no-progress

Specifying the file type to check

To skip checking of Php or Blade files, pass --no-php or --no-blade respectively:

php artisan config:check --no-php
php artisan config:check --no-blade

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.