Laravel Modules

https://github.com/nwidart/laravel-modules
Admin
A Laravel package for managing large applications using modular architecture with support for...
Tokens:84,950
Snippets:612
Trust Score:-
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Quick start commands

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Create a module, list modules, and enable/disable modules using artisan commands.

```bash
php artisan module:make Blog      # create a module
php artisan module:list           # list modules and their status
php artisan module:disable Blog   # stop booting the module
php artisan module:enable Blog    # boot it again
```

--------------------------------

### Install dev dependencies with composer install

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Run after cloning your fork to install the development dependencies required for contributing.

```bash
composer install
```

--------------------------------

### Publish the config file (optional)

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Publish the package configuration file using the vendor:publish command with the provider name.

```bash
php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"
```

--------------------------------

### Composer Commands for Setup, Testing, Linting, and Analysis

Source: https://github.com/nwidart/laravel-modules/blob/master/AGENTS.md

Lists the primary Composer commands used in the repository. `composer check` runs lint, analysis, and tests as CI does. `composer test` runs the full PHPUnit suite without coverage. `composer update-snapshots` regenerates Spatie snapshot files after intended output changes, optionally for a single test path. `composer lint` fixes files with Pint using the Laravel preset, while `composer lint:check` only reports without changing files. `composer analyse` runs PHPStan with Larastan at level 6 on `src/`. `composer test-coverage` generates an HTML report in `build/coverage` and requires Xdebug or PCOV.

```bash
composer install
```

```bash
composer check                      # lint:check + analyse + test, the same checks CI runs
```

```bash
composer test                       # phpunit, full suite, no coverage
```

```bash
vendor/bin/phpunit tests/Commands/Make/ControllerMakeCommandTest.php
```

```bash
vendor/bin/phpunit --filter test_it_generated_correct_file_with_content
```

```bash
composer update-snapshots           # regenerate spatie snapshot files after intended output changes
```

```bash
composer update-snapshots -- tests/Commands/Make/ControllerMakeCommandTest.php   # one test path only
```

```bash
composer lint                       # pint (preset: laravel), fixes files
```

```bash
composer lint:check                 # pint --test, reports without changing files
```

```bash
composer analyse                    # phpstan + Larastan (phpstan.neon.dist, level 6, src/)
```

```bash
composer test-coverage              # HTML report in build/coverage; needs Xdebug or PCOV
```

--------------------------------

### Composer trust prompt for merge-plugin

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

On first install, Composer asks whether to trust wikimedia/composer-merge-plugin. Answer 'y' to enable it.

```text
Do you trust "wikimedia/composer-merge-plugin" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?]
```

--------------------------------

### Preview next version and CHANGELOG with git-cliff

Source: https://github.com/nwidart/laravel-modules/blob/master/RELEASING.md

Run these commands from the branch you want to release to preview the next version and the next CHANGELOG section. Requires git-cliff to be installed.

```bash
git fetch --tags
git-cliff --use-branch-tags --bumped-version              # next version
git-cliff --use-branch-tags --unreleased --strip all       # next CHANGELOG section
```

--------------------------------

### Install laravel-modules via Composer

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Install the package with Composer. The service provider and alias are registered automatically.

```bash
composer require nwidart/laravel-modules
```

--------------------------------

### Blog Module Service Provider

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_module_with_resources__1.txt

Defines the Blog module's service provider with name properties and provider registrations. Includes commented-out command and schedule configuration examples.

```php
<?php

namespace Modules\Blog\Providers;

use Nwidart\Modules\Support\ModuleServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class BlogServiceProvider extends ModuleServiceProvider
{
    /**
     * The name of the module.
     */
    protected string $name = 'Blog';

    /**
     * The lowercase version of the module name.
     */
    protected string $nameLower = 'blog';

    /**
     * Command classes to register.
     *
     * @var string[]
     */
    // protected array $commands = [];

    /**
     * Provider classes to register.
     *
     * @var string[]
     */
    protected array $providers = [
        EventServiceProvider::class,
        RouteServiceProvider::class,
    ];

    /**
     * Define module schedules.
     * 
     * @param $schedule
     */
    // protected function configureSchedules(Schedule $schedule): void
    // {
    //     $schedule->command('inspire')->hourly();
    // }
}
```

--------------------------------

### API Controller for Blog Module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ControllerMakeCommandTest__test_it_generates_an_api_controller__1.txt

Generated API controller for the Blog module. It extends the base controller and includes index, store, show, update, and destroy methods, each returning an empty JSON response. Use this as a starting point for implementing RESTful API endpoints.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class MyController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index()
    {
        //

        return response()->json([]);
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request)
    {
        //

        return response()->json([]);
    }

    /**
     * Show the specified resource.
     */
    public function show($id)
    {
        //

        return response()->json([]);
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, $id)
    {
        //

        return response()->json([]);
    }

    /**
     * Remove the specified resource from storage.
     */
    public function destroy($id)
    {
        //

        return response()->json([]);
    }
}
```

--------------------------------

### Generated Job Class for Blog Module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/JobMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

Example of a job class generated by the module:make-job command for the Blog module. It implements ShouldQueue and uses the Queueable trait, with empty constructor and handle methods.

```php
<?php

namespace Modules\Blog\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;

class SomeJob implements ShouldQueue
{
    use Queueable;

    /**
     * Create a new job instance.
     */
    public function __construct() {}

    /**
     * Execute the job.
     */
    public function handle(): void {}
}
```

--------------------------------

### Conventional Commits examples

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Example commit messages following the Conventional Commits format. The scope is optional and lowercase; breaking changes add ! after the type or scope.

```text
feat(make): add module:make-foo command
fix(migrations): honour --pretend on module:migrate-rollback
docs: explain the activator config
test(commands): cover module:enable with --all
revert: feat(make): add module:make-foo command
```

--------------------------------

### Add allow-plugins config to composer.json

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Alternatively, add the allow-plugins configuration manually to composer.json to trust the merge plugin.

```json
"config": {
    "allow-plugins": {
        "wikimedia/composer-merge-plugin": true
    }
}
```

--------------------------------

### Add merge-plugin configuration to composer.json

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Add the wikimedia/composer-merge-plugin configuration to the extra section of your app's composer.json to autoload module classes.

```json
"extra": {
    "laravel": {
        "dont-discover": []
    },
    "merge-plugin": {
        "include": [
            "Modules/*/composer.json"
        ]
    }
},
```

--------------------------------

### Regenerate autoload files

Source: https://github.com/nwidart/laravel-modules/blob/master/README.md

Run composer dump-autoload after changing composer.json to regenerate the autoloader.

```bash
composer dump-autoload
```

--------------------------------

### PHP test class for EloquentPostRepositoryTest

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/TestMakeCommandTest__test_it_can_change_the_default_feature_namespace_specific__1.txt

Defines a test case in the Modules\Blog\SuperTests\Feature namespace. The test method sends a GET request to '/' and asserts a 200 status.

```php
<?php

namespace Modules\Blog\SuperTests\Feature;

use Tests\TestCase;

class EloquentPostRepositoryTest extends TestCase
{
    /**
     * A basic test example.
     */
    public function test_the_application_returns_a_successful_response(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}
```

--------------------------------

### Generated Cast Class with Custom Namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/CastMakeCommandTest__test_it_can_change_the_default_namespace__1.txt

Snapshot of the generated cast class when the default namespace is changed to Modules\Blog\Domain\Casts. Implements CastsAttributes with get and set methods.

```php
<?php

namespace Modules\Blog\Domain\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MyCast implements CastsAttributes
{
    /**
     * Cast the given value.
     */
    public function get(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }

    /**
     * Prepare the given value for storage.
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }
}

```

--------------------------------

### Migration file for product_details table

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModelMakeCommandTest__test_it_generates_correct_migration_file_name_with_multiple_words_model__1.txt

This migration file creates the 'product_details' table with standard ID and timestamp columns. It includes the necessary up and down methods for schema migration.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('product_details', function (Blueprint $table) {
            $table->id();
            
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('product_details');
    }
};
```

--------------------------------

### Run static analysis with composer analyse

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Runs PHPStan static analysis.

```bash
composer analyse
```

--------------------------------

### Middleware class for Blog module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MiddlewareMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

Generated middleware file for the Blog module. The handle method passes the request to the next middleware in the pipeline.

```php
<?php

namespace Modules\Blog\Http\Middleware;

use Closure;
use Illuminate\Http\Request;

class SomeMiddleware
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next)
    {
        return $next($request);
    }
}
```

--------------------------------

### Run all tests with composer test

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Executes the full test suite.

```bash
composer test
```

--------------------------------

### Generated Job Middleware Class (RateLimited)

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/JobMiddlewareMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

Snapshot of the file generated by the JobMiddlewareMakeCommand for the Blog module. Contains a handle method that processes the queued job and calls the next middleware.

```php
<?php

namespace Modules\Blog\Jobs\Middleware;

use Closure;

class RateLimited
{
    /**
     * Process the queued job.
     *
     * @param  Closure(object): void  $next
     */
    public function handle(object $job, Closure $next): void
    {
        $next($job);
    }
}
```

--------------------------------

### Generated Repository Class (MyRepository)

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/RepositoryMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

This is the expected output of the repository make command. It defines a class named MyRepository in the Modules\Blog\Repositories namespace with a handle method.

```php
<?php

namespace Modules\Blog\Repositories;

class MyRepository
{
    public function handle() {}
}
```

--------------------------------

### Generated Middleware Class with Custom Namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MiddlewareMakeCommandTest__test_it_can_change_the_default_namespace_specific__1.txt

This is the expected output of the `middleware:make` command when the default namespace is set to `Modules\Blog\Middleware`. The class is named `SomeMiddleware` and includes the standard `handle` method signature. Use this as a reference for verifying the command's behavior with custom namespaces.

```php
<?php

namespace Modules\Blog\Middleware;

use Closure;
use Illuminate\Http\Request;

class SomeMiddleware
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next)
    {
        return $next($request);
    }
}
```

--------------------------------

### Generated Cast Class Implementation

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/CastMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

This class implements the CastsAttributes interface for custom Eloquent attribute casting. It provides default get and set methods that return the value as-is.

```php
<?php

namespace Modules\Blog\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MyCast implements CastsAttributes
{
    /**
     * Cast the given value.
     */
    public function get(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }

    /**
     * Prepare the given value for storage.
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }
}
```

--------------------------------

### Generated API Route File for Blog Module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_route_file__1.txt

This is the expected output of the module:make command for generating an API route file. It defines a route group with 'auth:sanctum' middleware and a 'v1' prefix, registering an apiResource for 'blogs' with the BlogController and naming the routes 'blog'.

```php
<?php

use Illuminate\Support\Facades\Route;
use Modules\Blog\Http\Controllers\BlogController;

Route::middleware(['auth:sanctum'])->prefix('v1')->group(function () {
    Route::apiResource('blogs', BlogController::class)->names('blog');
});
```

--------------------------------

### RouteServiceProvider for a Laravel module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_module_with_resources__4.txt

Generated by the module:make command for a module named Blog. It registers web routes with the 'web' middleware and API routes with the 'api' middleware, an 'api' prefix, and an 'api.' name prefix, using module_path() to reference the module's routes files.

```php
<?php

namespace Modules\Blog\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    protected string $name = 'Blog';

    /**
     * Called before routes are registered.
     *
     * Register any model bindings or pattern based filters.
     */
    public function boot(): void
    {
        parent::boot();
    }

    /**
     * Define the routes for the application.
     */
    public function map(): void
    {
        $this->mapApiRoutes();
        $this->mapWebRoutes();
    }

    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     */
    protected function mapWebRoutes(): void
    {
        Route::middleware('web')->group(module_path($this->name, '/routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     */
    protected function mapApiRoutes(): void
    {
        Route::middleware('api')->prefix('api')->name('api.')->group(module_path($this->name, '/routes/api.php'));
    }
}
```

--------------------------------

### Generated Vue Inertia page template

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/InertiaPageMakeCommandTest__test_it_generates_a_vue_inertia_page_with_correct_content__1.txt

Default template for a generated Inertia page. Includes a script setup block with Head import and defineProps placeholder, and a template with a basic page layout.

```vue
<script setup>
import { Head } from '@inertiajs/vue3'

defineProps({
    // Add your props here
})
</script>

<template>
    <div>
        <Head title="Blog - Index" />

        <div class="py-12">
            <div class="max-w-7xl mx-auto sm:px-6 lg:px-8">
                <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg">
                    <div class="p-6">
                        <h1 class="text-2xl font-bold">Index</h1>
                        <p class="mt-4">Blog module - Index page</p>
                    </div>
                </div>
            </div>
        </div>
    </div>
</template>
```

--------------------------------

### Generated Blog module controller with resource methods

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ControllerMakeCommandTest__test_it_appends_controller_to_class_name_if_not_present__1.txt

Generated controller for the Blog module. It extends the base Controller and includes standard resource methods (index, create, store, show, edit, update, destroy) with views referenced using the 'blog::' namespace.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class MyController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index()
    {
        return view('blog::index');
    }

    /**
     * Show the form for creating a new resource.
     */
    public function create()
    {
        return view('blog::create');
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request) {}

    /**
     * Show the specified resource.
     */
    public function show($id)
    {
        return view('blog::show');
    }

    /**
     * Show the form for editing the specified resource.
     */
    public function edit($id)
    {
        return view('blog::edit');
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, $id) {}

    /**
     * Remove the specified resource from storage.
     */
    public function destroy($id) {}
}
```

--------------------------------

### Generated BlogServiceProvider with ModuleServiceProvider

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generate_module_when_provider_is_enable_and_event_provider_is_disable__1.txt

Snapshot of the generated module service provider for the Blog module. Extends ModuleServiceProvider, defines module name and lower name, and registers RouteServiceProvider. Commands and schedule configuration are commented out by default.

```php
<?php

namespace Modules\Blog\Providers;

use Nwidart\Modules\Support\ModuleServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class BlogServiceProvider extends ModuleServiceProvider
{
    /**
     * The name of the module.
     */
    protected string $name = 'Blog';

    /**
     * The lowercase version of the module name.
     */
    protected string $nameLower = 'blog';

    /**
     * Command classes to register.
     *
     * @var string[]
     */
    // protected array $commands = [];

    /**
     * Provider classes to register.
     *
     * @var string[]
     */
    protected array $providers = [
        RouteServiceProvider::class,
    ];

    /**
     * Define module schedules.
     * 
     * @param $schedule
     */
    // protected function configureSchedules(Schedule $schedule): void
    // {
    //     $schedule->command('inspire')->hourly();
    // }
}
```

--------------------------------

### Generate web route file for a module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_web_route_file__1.txt

Defines a web route group for the Blog module, applying the 'auth' and 'verified' middleware and registering a resourceful route for 'blogs' with the name 'blog'. This file is generated by the ModuleMakeCommand and is intended to be placed in the module's Routes/web.php.

```php
<?php

use Illuminate\Support\Facades\Route;
use Modules\Blog\Http\Controllers\BlogController;

Route::middleware(['auth', 'verified'])->group(function () {
    Route::resource('blogs', BlogController::class)->names('blog');
});
```

--------------------------------

### Generated Cast Class with Custom Namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/CastMakeCommandTest__test_it_can_change_the_default_namespace_specific__1.txt

Snapshot of the generated cast class when the default namespace is changed to 'Blog\Support\Casts'. The class implements CastsAttributes with get and set methods.

```php
<?php

namespace Modules\Blog\Support\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MyCast implements CastsAttributes
{
    /**
     * Cast the given value.
     */
    public function get(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }

    /**
     * Prepare the given value for storage.
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): mixed
    {
        return $value;
    }
}

```

--------------------------------

### Generated web route file for multi-segment module namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_web_route_file_with_multi_segment_default_namespace__1.txt

Generated web route file for a module with a multi-segment default namespace. It registers a resource route for 'blogs' under the 'auth' and 'verified' middleware, using the BlogController from the Custom\Modules\Blog namespace.

```php
<?php

use Illuminate\Support\Facades\Route;
use Custom\Modules\Blog\Http\Controllers\BlogController;

Route::middleware(['auth', 'verified'])->group(function () {
    Route::resource('blogs', BlogController::class)->names('blog');
});
```

--------------------------------

### Laravel Feature Test: Assert Successful Response

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/TestMakeCommandTest__test_it_can_change_the_default_feature_namespace__1.txt

A basic Laravel feature test that verifies the application returns a successful HTTP 200 response for the root route. The test uses the TestCase base class and the get method to make a request, then asserts the status code is 200.

```php
<?php

namespace Modules\Blog\SuperTests\Feature;

use Tests\TestCase;

class EloquentPostRepositoryTest extends TestCase
{
    /**
     * A basic test example.
     */
    public function test_the_application_returns_a_successful_response(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

```

--------------------------------

### Create GitHub release for new major

Source: https://github.com/nwidart/laravel-modules/blob/master/RELEASING.md

Creates a GitHub release for the new major version using the changelog section as notes.

```bash
gh release create v14.0.0 --title v14.0.0 --notes-file <section>
```

--------------------------------

### Generated BlogDatabaseSeeder class

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_module_resources__5.txt

Default seeder generated for the Blog module. The run method is empty except for a commented-out $this->call([]) placeholder, ready for custom seed logic.

```php
<?php

namespace Modules\Blog\Database\Seeders;

use Illuminate\Database\Seeder;

class BlogDatabaseSeeder extends Seeder
{
    /**
     * Run the database seeds.
     */
    public function run(): void
    {
        // $this->call([]);
    }
}
```

--------------------------------

### Tag and push new major release

Source: https://github.com/nwidart/laravel-modules/blob/master/RELEASING.md

Creates an annotated tag for the new major release and pushes it to origin.

```bash
git tag -a v14.0.0 -m v14.0.0 && git push origin v14.0.0
```

--------------------------------

### Custom RouteServiceProvider implementation

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/RouteProviderMakeCommandTest__test_it_can_change_the_default_namespace_specific__1.txt

This class defines the route mapping for the Blog module, specifying separate configurations for web and API routes using the module_path helper.

```php
<?php

namespace Modules\Blog\SuperProviders;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    protected string $name = 'Blog';

    /**
     * Called before routes are registered.
     *
     * Register any model bindings or pattern based filters.
     */
    public function boot(): void
    {
        parent::boot();
    }

    /**
     * Define the routes for the application.
     */
    public function map(): void
    {
        $this->mapApiRoutes();
        $this->mapWebRoutes();
    }

    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     */
    protected function mapWebRoutes(): void
    {
        Route::middleware('web')->group(module_path($this->name, '/routes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     */
    protected function mapApiRoutes(): void
    {
        Route::middleware('api')->prefix('api')->name('api.')->group(module_path($this->name, '/routes/api.php'));
    }
}
```

--------------------------------

### RouteServiceProvider Implementation

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/RouteProviderMakeCommandTest__test_it_can_overwrite_file__1.txt

Defines the RouteServiceProvider for the Blog module, including methods for mapping web and API routes with appropriate middleware and prefixes.

```php
<?php

namespace Modules\Blog\Providers;

use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    protected string $name = 'Blog';

    /**
     * Called before routes are registered.
     *
     * Register any model bindings or pattern based filters.
     */
    public function boot(): void
    {
        parent::boot();
    }

    /**
     * Define the routes for the application.
     */
    public function map(): void
    {
        $this->mapApiRoutes();
        $this->mapWebRoutes();
    }

    /**
     * Define the "web" routes for the application.
     *
     * These routes all receive session state, CSRF protection, etc.
     */
    protected function mapWebRoutes(): void
    {
        Route::middleware('web')->group(module_path($this->name, '/SuperRoutes/web.php'));
    }

    /**
     * Define the "api" routes for the application.
     *
     * These routes are typically stateless.
     */
    protected function mapApiRoutes(): void
    {
        Route::middleware('api')->prefix('api')->name('api.')->group(module_path($this->name, '/routes/api.php'));
    }
}
```

--------------------------------

### Trail CLI commands

Source: https://github.com/nwidart/laravel-modules/blob/master/AGENTS.md

Use these commands to query the code map. `trail ask` provides ranked answers with optional `--source` to inline code; `trail grep` groups hits by enclosing symbol; `trail skeleton` shows symbols and line spans; `trail callers` lists callers with `--direction out` for callees and `--depth N|all` for blast radius; `trail map` shows directories, hubs, and hotspots; `trail build` rebuilds the map and `--check` exits 1 when stale. Query commands refresh a stale map first; `--no-refresh` answers from the map as is.

```bash
trail ask "<task>" [--source]   # ranked file:line answer plus matching learnings; --source inlines the code
trail grep <pattern>            # every hit, grouped by enclosing symbol
trail skeleton <file>           # one file's symbols and line spans
trail callers <symbol>          # callers; --direction out for callees, --depth N|all for blast radius
trail map                       # directories, hubs, hotspots
trail build                     # rebuild .trail/cache/; --check exits 1 when the map is stale
```

--------------------------------

### Generated PostController class

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModelMakeCommandTest__test_it_generates_controller_and_migration_when_both_flags_are_present__1.txt

This is the controller generated by the ModelMakeCommand for the Blog module. It includes the standard resource methods, with index, create, show, and edit returning views using the 'blog::' namespace. The store, update, and destroy methods are empty stubs.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class PostController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index()
    {
        return view('blog::index');
    }

    /**
     * Show the form for creating a new resource.
     */
    public function create()
    {
        return view('blog::create');
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request) {}

    /**
     * Show the specified resource.
     */
    public function show($id)
    {
        return view('blog::show');
    }

    /**
     * Show the form for editing the specified resource.
     */
    public function edit($id)
    {
        return view('blog::edit');
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, $id) {}

    /**
     * Remove the specified resource from storage.
     */
    public function destroy($id) {}
}
```

--------------------------------

### Generated BlogDatabaseSeeder class

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_module_with_resources__3.txt

Default seeder class for the Blog module. The run method is empty except for a commented-out $this->call([]) line, which you can replace with calls to your own seeders.

```php
<?php

namespace Modules\Blog\Database\Seeders;

use Illuminate\Database\Seeder;

class BlogDatabaseSeeder extends Seeder
{
    /**
     * Run the database seeds.
     */
    public function run(): void
    {
        // $this->call([]);
    }
}

```

--------------------------------

### Generated API Route File Structure

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_route_file_with_multi_segment_default_namespace__1.txt

This file defines the API routes for the module, utilizing the sanctum authentication middleware and a versioned prefix. It maps the 'blogs' resource to the BlogController.

```php
<?php

use Illuminate\Support\Facades\Route;
use Custom\Modules\Blog\Http\Controllers\BlogController;

Route::middleware(['auth:sanctum'])->prefix('v1')->group(function () {
    Route::apiResource('blogs', BlogController::class)->names('blog');
});
```

--------------------------------

### Generated BlogServiceProvider for custom namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ProviderMakeCommandTest__test_it_can_change_the_default_namespace__1.txt

Shows the generated module service provider for a module named 'Blog' when using a custom namespace. It extends ModuleServiceProvider, sets the module name and lowercase name, and registers EventServiceProvider and RouteServiceProvider. Command registration and schedule configuration are commented out by default.

```php
<?php

namespace Modules\Blog\SuperProviders;

use Nwidart\Modules\Support\ModuleServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class BlogServiceProvider extends ModuleServiceProvider
{
    /**
     * The name of the module.
     */
    protected string $name = 'Blog';

    /**
     * The lowercase version of the module name.
     */
    protected string $nameLower = 'blog';

    /**
     * Command classes to register.
     *
     * @var string[]
     */
    // protected array $commands = [];

    /**
     * Provider classes to register.
     *
     * @var string[]
     */
    protected array $providers = [
        EventServiceProvider::class,
        RouteServiceProvider::class,
    ];

    /**
     * Define module schedules.
     * 
     * @param $schedule
     */
    // protected function configureSchedules(Schedule $schedule): void
    // {
    //     $schedule->command('inspire')->hourly();
    // }
}
```

--------------------------------

### Create Migration File Content for posts Table

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MigrationMakeCommandTest__test_it_generates_correct_create_migration_file_content__1.txt

This is the expected output of the migration make command for a create migration. It defines a posts table with an auto-incrementing id and timestamps, and drops the table on rollback.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();
            
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('posts');
    }
};
```

--------------------------------

### Migration file for posts table

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModelMakeCommandTest__test_it_generates_migration_file_with_model_using_shortcut_option__1.txt

This migration creates a 'posts' table with an ID and timestamps. It includes a down method to drop the table if necessary.

```php
<?php

use IlluminateDatabase\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();
            
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('posts');
    }
};
```

--------------------------------

### Generated SomeMiddleware class

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MiddlewareMakeCommandTest__test_it_can_change_the_default_namespace__1.txt

A generated middleware skeleton created by the module:make-middleware command. It applies the changed default namespace, Modules\Blog\Middleware, and includes a handle method that passes the request to the next middleware.

```php
<?php

namespace Modules\Blog\Middleware;

use Closure;
use Illuminate\Http\Request;

class SomeMiddleware
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next)
    {
        return $next($request);
    }
}

```

--------------------------------

### Generated repository class in Modules\Blog\Repositories\Api

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/RepositoryMakeCommandTest__test_it_can_generate_a_repository_in_sub_namespace_with_correct_generated_file__1.txt

Generated repository class in the Api sub-namespace of the Blog module. The class is empty except for a handle method placeholder.

```php
<?php

namespace Modules\Blog\Repositories\Api;

class MyRepository
{
    public function handle() {}
}
```

--------------------------------

### Format code with composer lint (Pint)

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Formats the codebase using Pint. CI runs this on every pull request and may commit fixes automatically.

```bash
composer lint
```

--------------------------------

### Generated Blog module service provider

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ProviderMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

Generated service provider class for a module named Blog. It extends the base ServiceProvider and includes empty register() and provides() methods, ready for customization.

```php
<?php

namespace Modules\Blog\Providers;

use Illuminate\Support\ServiceProvider;

class MyBlogServiceProvider extends ServiceProvider
{
    /**
     * Register the service provider.
     */
    public function register(): void {}

    /**
     * Get the services provided by the provider.
     */
    public function provides(): array
    {
        return [];
    }
}
```

--------------------------------

### Generated Job Middleware in Sub-namespace

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/JobMiddlewareMakeCommandTest__test_it_can_generate_a_job_middleware_in_sub_namespace_with_correct_generated_file__1.txt

Snapshot of the generated file for a job middleware class in a sub-namespace. The class is named RateLimited and is placed under Modules\Blog\Jobs\Middleware\Foo. It includes a handle method that processes the queued job.

```php
<?php

namespace Modules\Blog\Jobs\Middleware\Foo;

use Closure;

class RateLimited
{
    /**
     * Process the queued job.
     *
     * @param  Closure(object): void  $next
     */
    public function handle(object $job, Closure $next): void
    {
        $next($job);
    }
}
```

--------------------------------

### BlogServiceProvider class definition

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_module_resources__1.txt

The BlogServiceProvider class extends ModuleServiceProvider and defines the module's name, lowercase name, and registered service providers.

```php
<?php

namespace Modules\Blog\Providers;

use Nwidart\Modules\Support\ModuleServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class BlogServiceProvider extends ModuleServiceProvider
{
    /**
     * The name of the module.
     */
    protected string $name = 'Blog';

    /**
     * The lowercase version of the module name.
     */
    protected string $nameLower = 'blog';

    /**
     * Command classes to register.
     *
     * @var string[]
     */
    // protected array $commands = [];

    /**
     * Provider classes to register.
     *
     * @var string[]
     */
    protected array $providers = [
        EventServiceProvider::class,
        RouteServiceProvider::class,
    ];

    /**
     * Define module schedules.
     * 
     * @param $schedule
     */
    // protected function configureSchedules(Schedule $schedule): void
    // {
    //     $schedule->command('inspire')->hourly();
    // }
```

--------------------------------

### Generated PostFactory for Blog module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/FactoryMakeCommandTest__test_it_makes_factory__1.txt

Generated factory class for the Blog module's Post model. The $model property points to the module's model class, and the definition() method returns an empty array as the default state, which you can fill with fake data.

```php
<?php

namespace Modules\Blog\Database\Factories;

use Illuminate\Database\Eloquent\Factories\Factory;

class PostFactory extends Factory
{
    /**
     * The name of the factory's corresponding model.
     */
    protected $model = \Modules\Blog\Models\Post::class;

    /**
     * Define the model's default state.
     */
    public function definition(): array
    {
        return [];
    }
}

```

--------------------------------

### Generated Notification Class (WelcomeNotification)

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/NotificationMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

This is the expected output of the notification:make command for a module. It defines a notification class with a constructor, via, toMail, and toArray methods. The toMail method uses the MailMessage class to build a simple email with a line, action, and closing line.

```php
<?php

namespace Modules\Blog\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Messages\MailMessage;

class WelcomeNotification extends Notification
{
    use Queueable;

    /**
     * Create a new notification instance.
     */
    public function __construct() {}

    /**
     * Get the notification's delivery channels.
     */
    public function via($notifiable): array
    {
        return ['mail'];
    }

    /**
     * Get the mail representation of the notification.
     */
    public function toMail($notifiable): MailMessage
    {
        return (new MailMessage)
            ->line('The introduction to the notification.')
            ->action('Notification Action', 'https://laravel.com')
            ->line('Thank you for using our application!');
    }

    /**
     * Get the array representation of the notification.
     */
    public function toArray($notifiable): array
    {
        return [];
    }
}
```

--------------------------------

### BlogController RESTful Resource Methods

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generates_api_module_with_resources__2.txt

The BlogController class contains standard CRUD methods for handling API requests. Each method is pre-configured to return an empty JSON response.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class BlogController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index()
    {
        //

        return response()->json([]);
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request)
    {
        //

        return response()->json([]);
    }

    /**
     * Show the specified resource.
     */
    public function show($id)
    {
        //

        return response()->json([]);
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, $id)
    {
        //

        return response()->json([]);
    }

    /**
     * Remove the specified resource from storage.
     */
    public function destroy($id)
    {
        //

        return response()->json([]);
    }
}
```

--------------------------------

### Generated Mail Class (PHP)

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MailMakeCommandTest__test_it_generated_correct_file_with_content__1.txt

This is the expected output of the MailMakeCommand. It defines a mailable class with a constructor and a build method that returns a view.

```php
<?php

namespace Modules\Blog\Emails;

use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Queue\ShouldQueue;

class SomeMail extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     */
    public function __construct() {}

    /**
     * Build the message.
     */
    public function build(): self
    {
        return $this->view('view.name');
    }
}
```

--------------------------------

### Run composer check before opening a pull request

Source: https://github.com/nwidart/laravel-modules/blob/master/CONTRIBUTING.md

Runs composer lint:check, composer analyse, and composer test. CI runs the same checks.

```bash
composer check
```

--------------------------------

### PHP observer class for Post model

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ObserverMakeCommandTest__test_it_makes_observer__1.txt

Shows a PostObserver with created, updated, deleted, restored, and forceDeleted event methods.

```php
<?php

namespace Modules\Blog\Observers;

use Modules\Blog\Models\Post;

class PostObserver
{
    /**
     * Handle the Post "created" event.
     */
    public function created(Post $post): void {}

    /**
     * Handle the Post "updated" event.
     */
    public function updated(Post $post): void {}

    /**
     * Handle the Post "deleted" event.
     */
    public function deleted(Post $post): void {}

    /**
     * Handle the Post "restored" event.
     */
    public function restored(Post $post): void {}

    /**
     * Handle the Post "force deleted" event.
     */
    public function forceDeleted(Post $post): void {}
}
```

--------------------------------

### Generated Svelte Inertia page for Blog Index

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/InertiaPageMakeCommandTest__test_it_generates_a_svelte_inertia_page_with_correct_content__1.txt

Svelte component that imports the Inertia page helper and renders a simple index page with a title and description.

```svelte
<script>
    import { page } from '@inertiajs/svelte'
</script>

<svelte:head>
    <title>Blog - Index</title>
</svelte:head>

<div class="py-12">
    <div class="max-w-7xl mx-auto sm:px-6 lg:px-8">
        <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg">
            <div class="p-6">
                <h1 class="text-2xl font-bold">Index</h1>
                <p class="mt-4">Blog module - Index page</p>
            </div>
        </div>
    </div>
</div>
```

--------------------------------

### Mail class with custom namespace Modules\Blog\SuperEmails

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MailMakeCommandTest__test_it_can_change_the_default_namespace_specific__1.txt

Defines a Mailable class in the Modules\Blog\SuperEmails namespace. Uses Queueable and SerializesModels traits, implements ShouldQueue, and returns a view named 'view.name' from the build method.

```php
<?php

namespace Modules\Blog\SuperEmails;

use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Queue\ShouldQueue;

class SomeMail extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Create a new message instance.
     */
    public function __construct() {}

    /**
     * Build the message.
     */
    public function build(): self
    {
        return $this->view('view.name');
    }
}
```

--------------------------------

### Generated Post model with Fillable and UseFactory attributes

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModelMakeCommandTest__test_it_uses_the_fillable_and_factory_attributes_with_attributes_and_factory_options__1.txt

Snapshot of the generated model when using the --attributes and --factory options. The model uses PHP 8 attributes #[UseFactory] and #[Fillable] to define the factory and fillable fields, and includes the HasFactory trait.

```php
<?php

namespace Modules\Blog\Models;

use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Attributes\UseFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Modules\Blog\Database\Factories\PostFactory;

#[UseFactory(PostFactory::class)]
#[Fillable(["title","slug"])]
class Post extends Model
{
    /** @use HasFactory<PostFactory> */
    use HasFactory;
}
```

--------------------------------

### Generated queued event listener with ShouldQueue

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ListenerMakeCommandTest__test_it_generated_correct_queued_event_with_content__1.txt

Snapshot of the listener generated by the make:listener command with the --queued option for the Blog module. It implements ShouldQueue and uses InteractsWithQueue, with an empty constructor and handle method.

```php
<?php

namespace Modules\Blog\Listeners;

use Modules\Blog\Events\UserWasCreated;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class NotifyUsersOfANewPost implements ShouldQueue
{
    use InteractsWithQueue;

    /**
     * Create the event listener.
     */
    public function __construct() {}

    /**
     * Handle the event.
     */
    public function handle(UserWasCreated $event): void {}
}
```

--------------------------------

### Drop migration for posts table

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/MigrationMakeCommandTest__test_it_generates_correct_drop_migration_file_content__1.txt

Generated migration file for dropping the 'posts' table. The up() method uses Schema::dropIfExists('posts') to remove the table, while down() recreates it with an id and timestamps columns.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::dropIfExists('posts');
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();
            
            $table->timestamps();
        });
    }
};
```

--------------------------------

### Generated Resource Collection for Blog Module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ResourceMakeCommandTest__test_it_can_change_the_default_namespace__1.txt

This is the generated resource collection class for the Blog module. It extends ResourceCollection and overrides the toArray method to return the parent's result. The namespace and class name reflect the module's resource path.

```php
<?php

namespace Modules\Blog\Http\Resources;

use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\ResourceCollection;

class PostsTransformer extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     */
    public function toArray(Request $request): array
    {
        return parent::toArray($request);
    }
}

```

--------------------------------

### Generated BlogServiceProvider with disabled providers

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ModuleMakeCommandTest__test_it_generate_module_when_provider_is_enable_and_route_and_event_providers_are_disable__1.txt

Snapshot of the generated service provider for the Blog module when route and event providers are disabled. Includes commented-out commands and schedule configuration placeholders.

```php
<?php

namespace Modules\Blog\Providers;

use Nwidart\Modules\Support\ModuleServiceProvider;
use Illuminate\Console\Scheduling\Schedule;

class BlogServiceProvider extends ModuleServiceProvider
{
    /**
     * The name of the module.
     */
    protected string $name = 'Blog';

    /**
     * The lowercase version of the module name.
     */
    protected string $nameLower = 'blog';

    /**
     * Command classes to register.
     *
     * @var string[]
     */
    // protected array $commands = [];

    /**
     * Provider classes to register.
     *
     * @var string[]
     */
    protected array $providers = [];

    /**
     * Define module schedules.
     * 
     * @param $schedule
     */
    // protected function configureSchedules(Schedule $schedule): void
    // {
    //     $schedule->command('inspire')->hourly();
    // }
}
```

--------------------------------

### Generated MyController.php

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ControllerMakeCommandTest__test_it_generates_a_plain_controller__1.txt

The resulting controller file generated within the Blog module, extending the base Illuminate Routing Controller.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use Illuminate\Routing\Controller;

class MyController extends Controller {}
```

--------------------------------

### Generated Listener Class Structure

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ListenerMakeCommandTest__test_it_can_change_the_default_namespace__1.txt

The event listener class with namespace `Modules\Blog\Events\Handlers`, imports `InteractsWithQueue` and `ShouldQueue`, and has an empty constructor and `handle` method. This is the exact output from the test snapshot.

```php
<?php

namespace Modules\Blog\Events\Handlers;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class NotifyUsersOfANewPost
{
    /**
     * Create the event listener.
     */
    public function __construct() {}

    /**
     * Handle the event.
     */
    public function handle($event): void {}
}
```

--------------------------------

### Inertia Controller for Blog Module

Source: https://github.com/nwidart/laravel-modules/blob/master/tests/Commands/Make/__snapshots__/ControllerMakeCommandTest__test_it_generates_an_inertia_controller__1.txt

Generated Inertia controller for a Laravel module. It includes resource methods: index, create, store, show, edit, update, and destroy. The index, create, show, and edit methods return Inertia responses rendering views under the 'Blog' namespace. The store, update, and destroy methods are placeholders with empty bodies.

```php
<?php

namespace Modules\Blog\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Inertia\Inertia;
use Inertia\Response;

class MyController extends Controller
{
    /**
     * Display a listing of the resource.
     */
    public function index(): Response
    {
        return Inertia::render('Blog/Index');
    }

    /**
     * Show the form for creating a new resource.
     */
    public function create(): Response
    {
        return Inertia::render('Blog/Create');
    }

    /**
     * Store a newly created resource in storage.
     */
    public function store(Request $request)
    {
        //
    }

    /**
     * Show the specified resource.
     */
    public function show($id): Response
    {
        return Inertia::render('Blog/Show', [
            //
        ]);
    }

    /**
     * Show the form for editing the specified resource.
     */
    public function edit($id): Response
    {
        return Inertia::render('Blog/Edit', [
            //
        ]);
    }

    /**
     * Update the specified resource in storage.
     */
    public function update(Request $request, $id)
    {
        //
    }

    /**
     * Remove the specified resource from storage.
     */
    public function destroy($id)
    {
        //
    }
}
```
Tokens:
Raw