Get insights about your Laravel Project. (Inspired by rake stats)
The easiest way to install the the package is by using composer (The package is currently in BETA). The package requires PHP 7.0 and Laravel 5.5 or higher.
composer require "wnx/laravel-stats:1.0.0-beta-2"The package will automatically register itself.
Optionally, you can publish the config file of this package with this command:
php artisan vendor:publish --provider="Wnx\LaravelStats\StatsServiceProvider"The following config file will be published in config/stats.php
<?php
return [
/*
* List of folders to be analyzed.
*/
'paths' => [
base_path('app'),
base_path('database'),
],
/*
* List of files/folders to be excluded from analysis.
*/
'exclude' => [
// base_path('app/helpers.php'),
// base_path('app/Services'),
],
];After installing you can generate the statistics by running the following Artisan Command.
php artisan statsThe package scans the files defined in the paths-array in the configuration file. It then applies Classifiers to those classes to determine which Laravel Component the class represents.
| Component | Classification |
|---|---|
| Controller | Must be registered with a Route |
| Model | Must extend Illuminate\Database\Eloquent\Model |
| Command | Must extend Illuminate\Console\Command |
| Rule | Must extend Illuminate\Contracts\Validation\Rule |
| Policy | The Policy must be registered in your AuthServiceProvider |
| Middleware | The Middleware must be registered in your Http-Kernel |
| Event | Must use Illuminate\Foundation\Events\Dispatchable-Trait |
Must extend Illuminate\Mail\Mailable |
|
| Notification | Must extend Illuminate\Notifications\Notification |
| Job | Must use Illuminate\Foundation\Bus\Dispatchable-Trait |
| Migration | Must extend Illuminate\Database\Migrations\Migration |
| Request | Must extend Illuminate\Foundation\Http\FormRequest |
| Resource | Must extend Illuminate\Http\Resources\Json\Resource |
| Seeder | Must extend Illuminate\Database\Seeder |
| ServiceProvider | Must extend Illuminate\Support\ServiceProvider |
The package has tests written in phpunit. You can run them with the following command.
./vendor/bin/phpunitWe use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE file for details.