README

🚀 Laravel 12+ Focused Module Generator

Modular CRUD Generator for Laravel + Vue + Tailwind (shadcn-vue) - Optimized for Laravel 12+ with PHP 8.2+

Version 4.6 is a complete refactor focused exclusively on Laravel 12+ with comprehensive testing, improved code generation, modern best practices, and smart routes auto-installation.

📋 Requirements

PHP: ^8.2
Laravel: ^12.0
Spatie Laravel Permission: ^6.0

📦 Installation

Quick Installation

composer require ngodingskuyy/laravel-module-generator --dev

⚠️ If You Encounter Version Conflicts

Due to older versions on Packagist, you might need to install from source:

# Option 1: Install from GitHub (Recommended)
composer config repositories.ngodingskuyy-laravel-module-generator vcs https://github.com/ilhamridho04/laravel-module-generator
composer require ngodingskuyy/laravel-module-generator:dev-main --dev

# Option 2: Local development
git clone https://github.com/ilhamridho04/laravel-module-generator.git packages/laravel-module-generator
composer config repositories.local path ./packages/laravel-module-generator
composer require ngodingskuyy/laravel-module-generator:@dev --dev

For detailed troubleshooting, see DEVELOPMENT.md

🚀 Features

✨ What's New in v4.5

🎯 Smart Routes Auto-Installation: Automatic routes integration with zero manual setup
🔧 Enhanced Commands: New module:setup and module:install commands
🌐 Complete Routes Separation: Web and API routes properly separated
🤖 Interactive Installation: Auto-detect and offer installation when generating features
🧪 Comprehensive Testing: 98 tests with 385+ assertions (94% pass rate)
� Laravel 11+ Support: Full support for routes/app.php and traditional routes
� API Responser Integration: Consistent JSON responses with reusable trait
🎨 Mode Selection: Full-stack, API-only, or View-only generation modes

🔧 Core Features

✅ Full CRUD Generation: Model, migration, controller, requests, Vue components, routes, permission seeder
📦 Modular Architecture: Better separation of concerns per feature
🎨 Modern Frontend: Vue 3 + TailwindCSS + shadcn-vue components
🔐 Permission System: Auto-generated permissions using Spatie Laravel Permission
🧰 Customizable Stubs: Fully customizable templates with intelligent fallback support
🔧 Optional Components: Generate factories, policies, observers, enums, and tests on demand
🌐 Smart Routes: Auto-setup and integration with proper web/API separation

� Requirements

PHP: ^8.2
Laravel: ^11.0
Spatie Laravel Permission: ^6.0

�📦 Installation

composer require ngodingskuyy/laravel-module-generator --dev

For local development/testing:

{
  "repositories": [
    {
      "type": "path",
      "url": "./path/to/laravel-module-generator"
    }
  ]
}

Then:

composer require ngodingskuyy/laravel-module-generator:@dev

🔧 Usage

Interactive Mode (Recommended)

# Interactive menu will appear to choose generation mode
php artisan module:create User

Interactive Menu Options:

🎯 Pilih mode pembuatan fitur:
   1. Full-stack (API + Views) - Lengkap dengan controller, routes, views
   2. API Only - Hanya API controller, routes, dan requests
   3. View Only - Hanya Vue views dan web controller

🤔 Pilih mode generation
  [1] Full-stack (API + Views)
  [2] API Only
  [3] View Only
 > 1

Direct Mode Options

API-Only Mode

Generate only API controllers, routes, and requests (no Vue views):

php artisan module:create User --api

What gets generated:

✅ Controller with JSON responses in app/Http/Controllers/Api/ folder
✅ API routes (routes/Modules/Users/api.php) with auth:sanctum middleware
✅ Store/Update Request classes
✅ Model, Migration, Permission seeder
❌ No Vue views

File Structure:

app/
├── Http/
│   ├── Controllers/
│   │   └── API/
│   │       └── UserController.php  # API Controller
│   └── Requests/
│       ├── StoreUserRequest.php
│       └── UpdateUserRequest.php
└── Models/
    └── User.php
routes/
└── Modules/
    └── Users/
        └── api.php  # API routes

View-Only Mode

Generate only Vue views and web controllers (no API routes or requests):

php artisan module:create User --view

What gets generated:

✅ Controller with Inertia responses and auth middleware
✅ Web routes (routes/Modules/Users/web.php)
✅ Vue components (Index, Create, Edit, Show)
✅ Model, Migration, Permission seeder
❌ No Request classes (uses simple validation)

Full-Stack Mode (Default)

Generate both API and Views (complete CRUD):

# These are equivalent
php artisan module:create User
# Select option 1 in interactive menu

What gets generated:

✅ Controller with Inertia responses
✅ Web routes
✅ Vue components
✅ Store/Update Request classes
✅ Model, Migration, Permission seeder

With Optional Components

php artisan module:create User --with=factory,policy,observer,enum,test

Force Overwrite Existing Files

php artisan module:create User --force

🗑️ Deleting Features

Delete Basic Feature

php artisan module:delete User

Delete with Optional Components

php artisan module:delete User --with=factory,policy,observer,enum,test

Delete All Components (including optional)

php artisan module:delete User --all

Force Delete (no confirmation)

php artisan module:delete User --force

What Gets Deleted

The module:delete command will remove:

Core Files: Model, Controller, Requests, Vue components, Routes, Migration, Permission seeder
Optional Components: Enum, Observer, Policy, Factory, Test files (if specified with --with or --all)
Empty Directories: Automatically cleans up empty directories after deletion
Service Provider: Removes observer registration from AppServiceProvider (if applicable)

⚠️ Warning: This action is irreversible. Make sure to backup your files or use version control.

🔗 Routes Auto-Installation (New in v4.5)

One-Command Setup (Recommended)

# Setup and install routes automatically
php artisan module:install

This will:

✅ Create routes/modules.php (web routes loader)
✅ Create routes/api-modules.php (API routes loader)
✅ Auto-integrate into routes/web.php or routes/app.php (Laravel 11+)
✅ Auto-integrate into routes/api.php

Manual Setup (Alternative)

# 1. Create loader files only
php artisan module:setup

# 2. Then manually add to routes/web.php:
# require __DIR__ . '/modules.php';

# 3. And to routes/api.php:
# require __DIR__ . '/api-modules.php';

Smart Auto-Installation

When you generate a feature, the system will automatically detect if routes are not installed and offer to install them:

php artisan module:create Product

# Output:
# ⚠️  Untuk mengaktifkan auto-loading web modules, pilih salah satu:
#    1. Otomatis install:
#       php artisan module:install
#
#    2. Manual install:
#       Di routes/web.php:
#       require __DIR__ . '/modules.php';
#
# 🤔 Mau auto-install sekarang? (yes/no) [yes]:

Routes Structure

After installation, your routes will be organized like this:

routes/
├── web.php              # Contains: require __DIR__ . '/modules.php';
├── api.php              # Contains: require __DIR__ . '/api-modules.php';
├── modules.php          # Auto-loads all web.php from Modules/
├── api-modules.php      # Auto-loads all api.php from Modules/
└── Modules/
    └── Products/
        ├── web.php      # Web routes with auth middleware
        └── api.php      # API routes with auth:sanctum middleware

Generated Files Structure

Running php artisan module:create User will generate:

📁 Generated Files:
├── app/Models/User.php                              # Eloquent Model with SoftDeletes
├── app/Http/Controllers/UserController.php         # Resource Controller
├── app/Http/Requests/StoreUserRequest.php         # Store Validation
├── app/Http/Requests/UpdateUserRequest.php        # Update Validation
├── resources/js/pages/Users/
│   ├── Index.vue                                   # List View
│   ├── Create.vue                                  # Create Form
│   ├── Edit.vue                                    # Edit Form
│   └── Show.vue                                    # Detail View
├── routes/Modules/Users/web.php                    # Module Routes
├── database/seeders/Permission/UsersPermissionSeeder.php  # Permissions
└── database/migrations/2025_xx_xx_create_users_table.php  # Migration

📁 Optional Components (with --with flag):
├── app/Factories/UserFactory.php                   # Model Factory
├── app/Policies/UserPolicy.php                     # Authorization Policy
├── app/Observers/UserObserver.php                  # Model Observer
├── app/Enums/UserStatus.php                        # Status Enum
└── tests/Feature/UserFeatureTest.php               # Feature Tests

📚 API Documentation

Commands Overview

The Laravel Module Generator provides four main commands for complete feature lifecycle management:

Command	Description	Purpose
`module:create`	Generate complete CRUD feature	Create new features
`module:delete`	Remove complete CRUD feature	Clean up features
`setup:modules-loader`	Create modular route loader	Setup route automation
`install:modules-loader`	Install route loader into Laravel	Integrate with Laravel routing

📝 `module:create` Command

Signature: module:create {name} {--with=*} {--force}

Description

Generates a complete CRUD feature with all necessary files including models, controllers, views, migrations, routes, and permissions.

Arguments

Argument	Type	Required	Description
`name`	string	Yes	The name of the feature to generate (PascalCase)

Options

Option	Type	Default	Description
`--with`	array	`[]`	Optional components to include
`--force`	flag	`false`	Overwrite existing files without confirmation

Optional Components (`--with`)

Component	Description	Generated Files
`factory`	Model factory for testing	`database/factories/{Name}Factory.php`
`policy`	Authorization policy	`app/Policies/{Name}Policy.php`
`observer`	Model observer	`app/Observers/{Name}Observer.php`
`enum`	Status enum class	`app/Enums/{Name}StatusEnum.php`
`test`	Feature test class	`tests/Feature/{Name}Test.php`

Generated Files (Core)

# Models
app/Models/{Name}.php

# Controllers  
app/Http/Controllers/{Name}Controller.php

# Requests
app/Http/Requests/{Name}/Store{Name}Request.php
app/Http/Requests/{Name}/Update{Name}Request.php

# Vue Components
resources/js/Pages/{Name}/Index.vue
resources/js/Pages/{Name}/Create.vue
resources/js/Pages/{Name}/Edit.vue
resources/js/Pages/{Name}/Show.vue

# Database
database/migrations/{timestamp}_create_{name}_table.php

# Routes
routes/{name}.php

# Seeders
database/seeders/{Name}PermissionSeeder.php

Usage Examples

# Basic feature generation
php artisan module:create Product

# With optional components
php artisan module:create Product --with=factory,policy,observer

# With all optional components
php artisan module:create Product --with=factory,policy,observer,enum,test

# Force overwrite existing files
php artisan module:create Product --force

# Multiple optional components (alternative syntax)
php artisan module:create Product --with factory --with policy --with observer

Return Codes

Code	Meaning
`0`	Success - All files generated successfully
`1`	Error - Missing required arguments or validation failed
`2`	Error - File already exists and `--force` not specified

🗑️ `module:delete` Command

Signature: module:delete {name} {--with=*} {--all} {--force}

Description

Safely removes all files associated with a feature, including optional components and empty directories.

Arguments

Argument	Type	Required	Description
`name`	string	Yes	The name of the feature to delete (PascalCase)

Options

Option	Type	Default	Description
`--with`	array	`[]`	Optional components to delete
`--all`	flag	`false`	Delete all components (core + optional)
`--force`	flag	`false`	Delete without confirmation prompt

Deletion Scope

Core Files (always deleted):

Model, Controller, Requests
Vue Components (Index, Create, Edit, Show)
Migration, Routes, Permission Seeder

Optional Files (with --with or --all):

Factory, Policy, Observer, Enum, Test files

Directory Cleanup:

Removes empty directories after file deletion
Maintains directory structure if other files exist

Usage Examples

# Delete core feature files
php artisan module:delete Product

# Delete with specific optional components
php artisan module:delete Product --with=factory,policy

# Delete everything (core + all optional)
php artisan module:delete Product --all

# Force delete without confirmation
php artisan module:delete Product --force

# Delete with confirmation showing file list
php artisan module:delete Product --with=factory,policy,observer

Interactive Confirmation

When --force is not used, the command shows:

List of files to be deleted
Confirmation prompt
Deletion progress with status for each file

Return Codes

Code	Meaning
`0`	Success - All specified files deleted
`1`	Error - Feature not found or validation failed
`2`	Cancelled - User declined confirmation

🔄 `setup:modules-loader` Command

Signature: setup:modules-loader {--force}

Description

Creates the modular route loader file that automatically discovers and loads route files from the routes/modules/ directory.

Options

Option	Type	Default	Description
`--force`	flag	`false`	Overwrite existing modules.php file

Generated Files

routes/modules.php    # Main modules loader file

Features

Auto-discovery: Recursively scans routes/modules/ directory
Performance optimized: Only loads existing files
Nested support: Handles subdirectories automatically
Cache compatible: Works with Laravel's route caching

Usage Examples

# Create modules loader
php artisan setup:modules-loader

# Force overwrite existing file
php artisan setup:modules-loader --force

Generated Code Structure

The generated routes/modules.php contains:

File existence checks for performance
Recursive directory scanning
Automatic route file inclusion
Error handling for missing directories

⚙️ `install:modules-loader` Command

Signature: install:modules-loader {--force}

Description

Integrates the modules loader into Laravel's main routing system by adding the include statement to routes/web.php.

Options

Option	Type	Default	Description
`--force`	flag	`false`	Add include even if already exists

Modifications

File Modified: routes/web.php

Added Code:

// Auto-load module routes
if (file_exists(__DIR__ . '/modules.php')) {
    require __DIR__ . '/modules.php';
}

Usage Examples

# Install modules loader into Laravel routing
php artisan install:modules-loader

# Force reinstall even if already present
php artisan install:modules-loader --force

Integration Process

Checks if routes/modules.php exists
Scans routes/web.php for existing installation
Adds include statement if not present
Provides status feedback

🏗️ Module Directory Structure

After setting up the modular loader system:

routes/
├── web.php                 # Main Laravel routes (includes modules.php)
├── modules.php            # Auto-generated modules loader
└── modules/               # Your modular routes directory
    ├── products.php       # Product feature routes
    ├── users.php          # User feature routes
    ├── admin/             # Admin module subdirectory
    │   ├── dashboard.php  # Admin dashboard routes
    │   └── reports.php    # Admin reports routes
    └── api/               # API module subdirectory
        ├── v1.php         # API v1 routes
        └── v2.php         # API v2 routes

Route File Example

routes/modules/products.php:

<?php

use App\Http\Controllers\ProductController;
use Illuminate\Support\Facades\Route;

Route::middleware(['auth', 'verified'])->group(function () {
    Route::resource('products', ProductController::class);
    Route::get('products/{product}/history', [ProductController::class, 'history'])->name('products.history');
});

🔧 Advanced Configuration

Custom Stub Files

You can publish and customize the stub templates:

# Publish stub files (if supported)
php artisan vendor:publish --tag=laravel-module-generator-stubs

# Or manually copy from:
vendor/ngodingskuyy/laravel-module-generator/src/stubs/
vendor/ngodingskuyy/laravel-module-generator/src/views/

Stub File Locations

src/stubs/
├── controller.stub          # Controller template
├── model.stub              # Model template  
├── request.store.stub      # Store request template
├── request.update.stub     # Update request template
├── migration.stub          # Migration template
├── routes.stub             # Routes template
├── seeder.permission.stub  # Permission seeder template
├── Enum.stub               # Enum template
├── Observer.stub           # Observer template
└── modules-loader.stub     # Modules loader template

src/views/
├── Index.vue.stub          # Index view template
├── Create.vue.stub         # Create view template
├── Edit.vue.stub           # Edit view template
└── Show.vue.stub           # Show view template

Environment Considerations

Development:

Use --force flag cautiously to avoid overwriting customizations
Test generated code before committing
Run tests after generation: vendor/bin/phpunit

Production:

Install as --dev dependency only
Don't include in production builds
Use route caching: php artisan route:cache

🧪 Testing Integration

Generated Test Files

When using --with=test, generates:

// tests/Feature/{Name}Test.php
class ProductTest extends TestCase
{
    /** @test */
    public function it_can_list_products() { /* ... */ }
    
    /** @test */  
    public function it_can_create_product() { /* ... */ }
    
    /** @test */
    public function it_can_update_product() { /* ... */ }
    
    /** @test */
    public function it_can_delete_product() { /* ... */ }
}

Running Tests

# Run all tests
vendor/bin/phpunit

# Run specific feature tests
vendor/bin/phpunit tests/Feature/ProductTest.php

# Run with coverage
vendor/bin/phpunit --coverage-html coverage/

🚨 Error Handling

Common Issues & Solutions

File Already Exists:

# Solution: Use --force flag
php artisan module:create Product --force

Permission Denied:

# Solution: Check directory permissions
chmod 755 app/Http/Controllers/
chmod 755 resources/js/Pages/

Stub File Missing:

# Solution: Reinstall package or check vendor directory
composer reinstall ngodingskuyy/laravel-module-generator

Route Not Loading:

# Solution: Check modules.php exists and is included
php artisan route:list | grep products

Debug Commands

# Check if commands are registered
php artisan list | grep "module:create\|module:delete\|setup:modules\|install:modules"

# Verify file generation
php artisan module:create TestFeature --force
ls -la app/Models/TestFeature.php
php artisan module:delete TestFeature --force

🧪 Comprehensive Testing (New in v4.2)

🎯 Test Suite Overview

Version 4.2 includes a comprehensive test suite with 37 tests and 164 assertions achieving 100% pass rate:

Unit Tests

ServiceProviderTest - Package registration and command availability
MakeFeatureCommandUnitTest - Command structure and signature validation
StubFilesTest - All stub files validation and placeholder checking
StubRenderingTest - Stub rendering and replacement logic

Feature Tests

MakeFeatureCommandTest - File generation and content validation
MakeFeatureCommandIntegrationTest - End-to-end command testing

Integration Tests

Real Laravel app integration
Command execution in isolated environment
Generated file validation
Optional component testing

🚀 GitHub Actions CI/CD

Automated testing pipeline with comprehensive validation:

# .github/workflows/run-tests.yml

Pipeline Features:

✅ Matrix Testing: PHP 8.2, 8.3 × Laravel 12
✅ Package Validation: Composer.json validation, syntax checking
✅ Laravel Integration: Fresh Laravel 12 app testing
✅ Command Testing: Verify module:create functionality with all options
✅ File Validation: Ensure all generated files contain correct content
✅ Dependency Testing: Validate Spatie Permission integration

🏃‍♂️ Local Testing

Run Complete Test Suite

# Run all 37 tests
vendor/bin/phpunit

# Run with detailed output
vendor/bin/phpunit --testdox

# Run specific test groups
vendor/bin/phpunit tests/Unit/
vendor/bin/phpunit tests/Feature/

Test Coverage

# Generate coverage report
vendor/bin/phpunit --coverage-html coverage-report

🔍 Test Validation

The test suite validates:

Stub File Integrity: All stubs exist and contain required placeholders
Code Generation: Generated files have correct syntax and structure
Command Options: --force and --with options work correctly
Vue Components: All Vue files have proper template structure
Database Integration: Migrations and seeders are properly generated
Permission System: Spatie Laravel Permission integration works
Package Registration: Service provider loads correctly in Laravel

Run with Coverage

./vendor/bin/phpunit --coverage-html coverage-report
# or use the provided script
./coverage.sh

Testing in Real Laravel App

# Install in a test Laravel 12 project
composer create-project laravel/laravel test-app
cd test-app
composer config repositories.local path ../
composer require ngodingskuyy/laravel-module-generator:@dev

# Test the command
php artisan module:create Product --with=test,factory,observer,enum

CI Pipeline Status

The workflow tests:

Package Validation - Syntax, dependencies, composer.json
Laravel Integration - Install package in fresh Laravel 11
Command Execution - Run module:create and verify file creation
Laravel Compatibility - Ensure no conflicts with Laravel core

🔄 Migration from v3.x to v4.2

⚠️ Breaking Changes

Version 4.2 includes breaking changes focused on Laravel 12+ support:

PHP Version: Minimum PHP 8.2 required
Laravel Version: Only Laravel 12+ supported
Dependencies: Updated to latest versions

📝 Migration Steps

Update PHP Version
```
# Ensure PHP 8.2+ is installed
php -v
```

Update Laravel Version

# Upgrade to Laravel 12+
composer require laravel/framework:^12.0

Update Package

# Update to v4.x
composer require ngodingskuyy/laravel-module-generator:^4.2

Update Spatie Permission

# Update to v6.x if not already
composer require spatie/laravel-permission:^6.0

Clear and Rebuild

composer dump-autoload
php artisan config:clear
php artisan cache:clear

🏷️ Legacy Support

Laravel 8-11: Use v3.x branch
PHP 7.4-8.1: Use v3.x branch
See 3.x documentation

🤝 Contributing

We welcome contributions! Please feel free to submit a Pull Request.

Development Setup

Fork the repository
Clone your fork: git clone https://github.com/yourusername/laravel-module-generator
Install dependencies: composer install
Run tests: ./vendor/bin/phpunit
Make your changes and test thoroughly
Submit a pull request

📋 Contribution Guidelines

Ensure all tests pass (vendor/bin/phpunit)
Follow PSR-12 coding standards
Add tests for new features
Update documentation as needed
Keep backwards compatibility where possible

�📄 License

Laravel Module Generator v4.2 - Focused on Laravel 12+, Enhanced with Comprehensive Testing, Built for Modern PHP Development

ngodingskuyy/laravel-module-generator

包简介

关键字：

README 文档

README

📋 Requirements

📦 Installation

Quick Installation

⚠️ If You Encounter Version Conflicts

🚀 Features

✨ What's New in v4.5

🔧 Core Features

� Requirements

�📦 Installation

🔧 Usage

Interactive Mode (Recommended)

Direct Mode Options

API-Only Mode

View-Only Mode

Full-Stack Mode (Default)

With Optional Components

Force Overwrite Existing Files

🗑️ Deleting Features

Delete Basic Feature

Delete with Optional Components

Delete All Components (including optional)

Force Delete (no confirmation)

What Gets Deleted

🔗 Routes Auto-Installation (New in v4.5)

One-Command Setup (Recommended)

Manual Setup (Alternative)

Smart Auto-Installation

Routes Structure

Generated Files Structure

📚 API Documentation

Commands Overview

📝 module:create Command

Description

Arguments

Options

Optional Components (--with)

Generated Files (Core)

Usage Examples

Return Codes

🗑️ module:delete Command

Description

Arguments

Options

Deletion Scope

Usage Examples

Interactive Confirmation

Return Codes

🔄 setup:modules-loader Command

Description

Options

Generated Files

Features

Usage Examples

Generated Code Structure

⚙️ install:modules-loader Command

Description

Options

Modifications

Usage Examples

Integration Process

🏗️ Module Directory Structure

Route File Example

🔧 Advanced Configuration

Custom Stub Files

Stub File Locations

Environment Considerations

🧪 Testing Integration

Generated Test Files

Running Tests

🚨 Error Handling

Common Issues & Solutions

Debug Commands

🧪 Comprehensive Testing (New in v4.2)

🎯 Test Suite Overview

Unit Tests

📝 `module:create` Command

Optional Components (`--with`)

🗑️ `module:delete` Command

🔄 `setup:modules-loader` Command

⚙️ `install:modules-loader` Command