Laravel Module Generator

Generate Laravel modules from opinionated templates — scaffold models, migrations, factories, seeders, requests, actions, controllers, Vue components/pages/stores, permissions, and full blueprint-driven module trees in seconds.

Built on top of nwidart/laravel-modules (^v10.0 || ^v11.0 || ^v12.0 || ^v13.0). Extends its module:make workflow with 19 additional create:* artisan commands and a stubs/modular template layer that also wires routes, dashboard links, and API resources automatically.

Table of Contents

• Requirements
• Installation
• Configuration
• Publishing Stubs
• Usage
  • Blueprint-Driven Generation
  • Sub-Module Scaffold
  • Model, Migration, Factory, Seeder, Request, Action
  • Controller
  • Vue Components, Pages & Stores
  • Permissions & API CRUD (non-modular)
  • All 19 Commands Reference
• Stub Customization
• Testing
• Changelog
• Security
• Contributing
• License
• Credits

Requirements

Supported matrix verified by tests/Unit/Compatibility/Laravel13CompatibilityTest.php (17 compatibility contract tests covering version constraints, provider registration, and stub API surface).

Installation

Install via Composer (package name is vheins/laravel-module-generator — see composer.json):

composer require vheins/laravel-module-generator

The service provider Vheins\LaravelModuleGenerator\Providers\LaravelModuleGeneratorServiceProvider is auto-discovered via extra.laravel.providers in composer.json — no manual registration required.

If auto-discovery is disabled, register it manually in config/app.php:

'providers' => [
    Vheins\LaravelModuleGenerator\Providers\LaravelModuleGeneratorServiceProvider::class,
],

Configuration

The package ships two config files:

• laravel-module-generator.php — package-specific settings (name => 'LaravelModuleGenerator').
• modules.php — full nwidart/laravel-modules configuration (namespace, stubs, paths, generators, activators, etc.).

Publish them with:

php artisan vendor:publish --provider="Vheins\LaravelModuleGenerator\Providers\LaravelModuleGeneratorServiceProvider" --tag=config

This copies laravel-module-generator.php to config/laravel-module-generator.php and modules.php to config/modules.php.

Key modules.php settings to be aware of:

• namespace defaults to Vheins — change to your organization namespace.
• stubs.path defaults to base_path('stubs/modular') — see Stub Customization.
• paths.modules defaults to base_path('modules') — generated modules land here.
• composer.vendor defaults to vheins and composer.author to Muhammad Rheza Alfin — update for your own scaffolds.

Publishing Stubs

Publish the full stub tree to base_path('stubs') for local customization:

php artisan vendor:publish --provider="Vheins\LaravelModuleGenerator\Providers\LaravelModuleGeneratorServiceProvider" --tag=stubs

Stubs published include:

• Top-level stubs (stubs/*.stub) — controllers, models, factories, migrations, actions, etc.
• Modular stubs (stubs/modular/**) — Vue components (component.filter, component.form.*, component.link, icontab), Vue pages (page.create, page.index, page.[id]), store.pinia, migrations, routes, scaffold config, etc.

Edit any published stub in place; subsequent generator runs will use your modified version.

Usage

All commands are registered by LaravelModuleGeneratorServiceProvider::COMMANDS (the canonical 19-command inventory) and are available only when runningInConsole() or runningUnitTests().

Blueprint-Driven Generation

Generate an entire module tree from a YAML blueprint file placed in .blueprint/:

php artisan create:module --blueprint=example.yaml

The command reads .blueprint/{file} via symfony/yaml, iterates module → subModule → tables, and for each entry:

• calls create:module:sub (with fillable and db-only derived from Fillable/CRUD keys),
• runs CreateRelation when Relation is present,
• runs CreateQuery when Query: true and collects query slugs for FixQueryApi.

Blueprint shape (keys are case-sensitive as parsed):

Invoice:
  InvoiceHeader:
    Fillable:
      number: string
      total: decimal
      company_id: foreignUuid
    CRUD: true
    Relation:
      # relation definition consumed by CreateRelation
    Query: true
  InvoiceLine:
    Fillable:
      invoice_header_id: foreignUuid
      amount: decimal
    CRUD: false   # db-only — no Vue/controllers/forms

Ends with optimize:clear.

Sub-Module Scaffold

The heavy lifter — creates a complete sub-module inside a parent module (creates the parent via module:make --api if it does not exist):

php artisan create:module:sub Invoice InvoiceLine --fillable="title:string,amount:decimal,company_id:foreignUuid"
php artisan create:module:sub Invoice InvoiceLine --fillable="title:string" --db-only

• module (required) — parent module name (StudlyCase).
• name (required) — sub-module / entity name.
• --fillable — comma-separated field:type pairs (e.g., title:string,amount:decimal).
• --db-only — when present, skips Vue components, controllers, requests, actions, routes, dashboard links, and store/pages.

When not --db-only, also generates Vue tab/link components, model + migration + factory + seeder, API controller, request, Store/Update/Delete actions, API route, dashboard link/tab entries, and Vue store + pages + form + filter, then runs optimize:clear.

Model, Migration, Factory, Seeder, Request, Action

# Model (with optional chained generators)
php artisan create:module:model Product Invoice --fillable="title:string,price:decimal"
php artisan create:module:model Product Invoice --fillable="title:string" --migration --controller --seed --request
# -m / --migration  also creates migration
# -c / --controller also creates controller
# -s / --seed       also creates seeder
# -r / --request    also creates request

# Migration
php artisan create:module:migration create_products_table create_products Invoice --fields="title:string,price:decimal"
php artisan create:module:migration create_products_table create_products Invoice --plain
# basename (arg 1), name (arg 2), module (arg 3 optional)

# Factory
php artisan create:module:factory Product Invoice --fillable="title:string,price:decimal"

# Seeder
php artisan create:module:seeder Product Invoice
php artisan create:module:seeder Product Invoice --master   # appends Database suffix

# Request
php artisan create:module:request ProductRequest Invoice --fillable="title:string,price:decimal"

# Action (lorisleiva/laravel-actions style)
php artisan create:module:action Product/Store Invoice
php artisan create:module:action Product/Update Invoice

Controller

php artisan create:module:controller Product Invoice
php artisan create:module:controller Product Invoice --api     # API resource controller
php artisan create:module:controller Product Invoice --plain   # plain controller (-p)

Vue Components, Pages & Stores

All Vue generators accept {name} {module?} [--fillable=] where name may be a compound like InvoiceProduct:

# Components
php artisan create:module:vue:component:tab   InvoiceProduct Invoice --fillable="title:string"
php artisan create:module:vue:component:link  InvoiceProduct Invoice --fillable="title:string"
php artisan create:module:vue:component:form  InvoiceProduct Invoice --fillable="title:string,amount:decimal"
php artisan create:module:vue:component:filter InvoiceProduct Invoice --fillable="title:string"

# Pages
php artisan create:module:vue:page:index InvoiceProduct Invoice --fillable="title:string"
php artisan create:module:vue:page:new   InvoiceProduct Invoice --fillable="title:string"
php artisan create:module:vue:page:view  InvoiceProduct Invoice --fillable="title:string"

# Pinia store
php artisan create:module:vue:store InvoiceProduct Invoice --fillable="title:string"

Generated paths (relative to modules/{Module}/):

• Components → Vue/components/
• Pages → Vue/pages/
• Stores → Vue/store/ (or vue/stores per modules.php generator config)

Permissions & API CRUD (non-modular)

These two commands operate on the host application (not inside modules/):

# Create 5 CRUD permissions for a resource (index/create/view/edit/delete)
php artisan create:permission posts
# creates: posts-index, posts-create, posts-view, posts-edit, posts-delete
# via App\Models\Permission::firstOrCreate()

# Scaffold a plain (non-modular) API CRUD: model + migration, requests, actions, controller
php artisan create:api:crud Post
php artisan create:api:crud Post --action   # also generates Store/Update/Delete actions

All 19 Commands Reference

Command list verified against Providers/LaravelModuleGeneratorServiceProvider.php::COMMANDS and individual Console/*.php signatures. File CreateModuleVuePageCreate registers as create:module:vue:page:new (not create).

Stub Customization

After publishing stubs:

php artisan vendor:publish --provider="Vheins\LaravelModuleGenerator\Providers\LaravelModuleGeneratorServiceProvider" --tag=stubs

• Edit any file under stubs/ or stubs/modular/ — the generators resolve stubs through Nwidart\Modules\Support\Stub, which prefers published paths.
• modules.php key stubs.replacements controls token replacements (LOWER_NAME, STUDLY_NAME, MODULE_NAMESPACE, etc.).
• Generator destinations are controlled by modules.php → paths.generator.* (model → Models, controller → Controllers, factory → database/factories, vue → vue, vue-components → Vue/components, etc.).
• Set a generator's generate flag to false to skip that path entirely.

Testing

composer install
vendor/bin/phpunit --no-coverage

--no-coverage is required because phpunit.xml.dist sets failOnWarning="true" — the coverage text reporter emits a warning when no coverage driver is present, which would otherwise fail the run. CI uses the same flag.

Test suite layout:

• tests/Unit/Compatibility/Laravel13CompatibilityTest.php — 17 tests: version-constraint matrix, provider/command registration, stub API guards.
• tests/Unit/Console/*Test.php — per-command generation tests (one file per command class).
• tests/TestCase.php + testbench.yaml — Orchestra Testbench harness (SQLite in-memory, APP_KEY is a testing-only dummy).

Additional tooling:

vendor/bin/pint --test        # style check (Laravel Pint)
vendor/bin/phpstan analyse    # static analysis (PHPStan)

Changelog

See CHANGELOG.md for a full history. This project follows Keep a Changelog and Semantic Versioning.

Security

If you discover a security vulnerability, please follow the process in SECURITY.md — do not open a public issue.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md and the Code of Conduct before opening a PR.

Quick start:

composer install
vendor/bin/phpunit --no-coverage
vendor/bin/pint
vendor/bin/phpstan analyse

License

MIT — see LICENSE.

Credits

• Original author: Muhammad Rheza Alfin (composer.json author field).
• Maintained by Vheins.
• Built on nwidart/laravel-modules and lorisleiva/laravel-actions.