Download the PHP package ngodingskuyy/laravel-module-generator without Composer

Laravel Module Generator v4.5

🚀 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

⚠️ If You Encounter Version Conflicts

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

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

For local development/testing:

Then:

🔧 Usage

Interactive Mode (Recommended)

Interactive Menu Options:

Direct Mode Options

API-Only Mode

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

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:

View-Only Mode

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

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):

What gets generated:

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

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

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)

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)

Smart Auto-Installation

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

Routes Structure

After installation, your routes will be organized like this:

Generated Files Structure

Running php artisan module:create User will generate:

📚 API Documentation

Commands Overview

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

📝 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

Options

Optional Components (--with)

Generated Files (Core)

Usage Examples

Return Codes

🗑️ 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

Options

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

Interactive Confirmation

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

1. List of files to be deleted
2. Confirmation prompt
3. Deletion progress with status for each file

Return Codes

🔄 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

Generated Files

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

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

Modifications

File Modified: routes/web.php

Added Code:

Usage Examples

Integration Process

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

🏗️ Module Directory Structure

After setting up the modular loader system:

Route File Example

routes/modules/products.php:

🔧 Advanced Configuration

Custom Stub Files

You can publish and customize the stub templates:

Stub File Locations

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:

Running Tests

🚨 Error Handling

Common Issues & Solutions

File Already Exists:

Permission Denied:

Stub File Missing:

Route Not Loading:

Debug Commands

🧪 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:

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

Test Coverage

🔍 Test Validation

The test suite validates:

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

Run with Coverage

Testing in Real Laravel App

CI Pipeline Status

The workflow tests:

1. Package Validation - Syntax, dependencies, composer.json
2. Laravel Integration - Install package in fresh Laravel 11
3. Command Execution - Run module:create and verify file creation
4. 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:

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

📝 Migration Steps

1. Update PHP Version

2. Update Laravel Version

3. Update Package

4. Update Spatie Permission

5. Clear and Rebuild

🏷️ 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

1. Fork the repository
2. Clone your fork: git clone https://github.com/yourusername/laravel-module-generator
3. Install dependencies: composer install
4. Run tests: ./vendor/bin/phpunit
5. Make your changes and test thoroughly
6. 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

MIT © 2025 NgodingSkuyy

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