scaffold-module
Scaffolds a new Domain Module structure in the Modular Monolith architecture. Use when creating a new module (e.g., "Create a new Inventory module").
📖 中文导读:Scaffolds a new Domain Module structure in the Modular Monolith architecture. Use when creating a new module (e.g., "Create a new Inventory module"). 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: scaffold-module description: Scaffolds a new Domain Module structure in the Modular Monolith architecture. Use when creating a new module (e.g., "Create a new Inventory module"). allowed-tools: Bash, Write, Read
Scaffold New Module
This skill creates the directory structure and core files for a new Module in app/Modules/{Module}.
Instructions
Analyze the Request: Identify the module name (PascalCase, Singular). Example:
Inventory.Create Directories: Run
mkdir -pfor:app/Modules/{Module}/Actionsapp/Modules/{Module}/Queriesapp/Modules/{Module}/Http/Controllers/Web/Adminapp/Modules/{Module}/Http/Controllers/Apiapp/Modules/{Module}/Http/Requests/{Module}app/Modules/{Module}/Modelsapp/Modules/{Module}/Policiesapp/Modules/{Module}/Providersapp/Modules/{Module}/routesapp/Modules/{Module}/tests
Create Service Provider: Create
app/Modules/{Module}/Providers/{Module}ServiceProvider.php.- It must extend
Illuminate\Support\ServiceProvider. - It should load routes from
routes/web.phpandroutes/api.php(if they exist). - It should load migrations if needed (though we use shared migrations usually, unless module specific).
- It should register policies if needed (though usually done in AuthServiceProvider or automatically discovered).
- It must extend
Create Route Files: Create empty route files:
app/Modules/{Module}/routes/web.phpapp/Modules/{Module}/routes/api.php
Register Module: Remind the user to register the
{Module}ServiceProviderinbootstrap/providers.phporconfig/app.php.
Template: Service Provider
<?php
namespace App\Modules\Inventory\Providers;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Facades\Route;
class InventoryServiceProvider extends ServiceProvider
{
public function boot(): void
{
$this->loadRoutes();
}
protected function loadRoutes(): void
{
if (file_exists(__DIR__ . '/../routes/web.php')) {
Route::middleware('web')
->group(__DIR__ . '/../routes/web.php');
}
if (file_exists(__DIR__ . '/../routes/api.php')) {
Route::prefix('api')
->middleware('api')
->group(__DIR__ . '/../routes/api.php');
}
}
}