InterNACHI/ modular
About the developer
154 Stars 
8 Forks 
MIT License 
107 Commits 
2 Opened issues 
Description
Modularize your Laravel application
Services available
Contributors list
InterNACHI/Modular
InterNACHI/Modularis a module system for Laravel applications. It uses Composer path repositories for autoloading, and Laravel package discovery for module initialization, and then provides minimal tooling to fill in any gaps.
This project is as much a set of conventions as it is a package. The fundamental idea is that you can create “modules” in a separate
app-modules/directory, which allows you to better organize large projects. These modules use the existing Laravel package system, and follow existing Laravel conventions.
Walkthrough Video
Installation
To get started, run:
shell script composer require internachi/modular
Laravel will auto-discover the package and everything will be automatically set up for you.
Publish the config
While not required, it's highly recommended that you customize your default namespace for modules. By default, this is set to
Modules\, which works just fine but makes it harder to extract your module to a separate package should you ever choose to.
We recommend configuring a organization namespace (we use
"InterNACHI", for example). To do this, you'll need to publish the package config:
shell script php artisan vendor:publish --tag=modular-config
Create a module
Next, let's create a module:
shell script php artisan make:module my-module
Modular will scaffold up a new module for you:
app-modules/
my-module/
composer.json
src/
tests/
routes/
resources/
database/
It will also add two new entries to your app's
composer.jsonfile. The first entry registers
./app-modules/my-module/as a path repository, and the second requires
modules/my-module:*(like any other Composer dependency).
Modular will then remind you to perform a Composer update, so let's do that now:
shell script composer update modules/my-module
Optional: Config synchronization
You can run the sync command to make sure that your project is set up for module support:
shell script php artisan modules:sync
This will add a
Modulestest suite to your
phpunit.xmlfile (if one exists) and update your PhpStorm Laravel plugin configuration (if it exists) to properly find your module's views.
It is safe to run this command at any time, as it will only add missing configurations. You may even want to add it to your
post-autoload-dumpscripts in your application's
composer.jsonfile.
Usage
All modules follow existing Laravel conventions, and auto-discovery should work as expected in most cases:
- Commands are auto-registered with Artisan
- Migrations will be run by the Migrator
- Factories are auto-loaded for
factory()
- Policies are auto-discovered for your Models
There is currently one exception:
- Event discovery (which is optional and disabled by default in Laravel) is currently not supported.
Commands
Package Commands
We provide a few helper commands:
-
php artisan make:module
— scaffold a new module -
php artisan modules:cache
— cache the loaded modules for slightly faster auto-discovery -
php artisan modules:clear
— clear the module cache -
php artisan modules:sync
— update project configs (likephpunit.xml
) with module settings -
php artisan modules:list
— list all modules
Laravel “make:
” Commands
We also add a
--module=option to most Laravel
make:commands so that you can use all the existing tooling that you know. The commands themselves are exactly the same, which means you can use your custom stubs and everything else Laravel provides:
php artisan make:cast MyModuleCast --module=my-module
php artisan make:controller MyModuleController --module=my-module
php artisan make:command MyModuleCommand --module=my-module
php artisan make:component MyModuleComponent --module=my-module
php artisan make:channel MyModuleChannel --module=my-module
php artisan make:event MyModuleEvent --module=my-module
php artisan make:exception MyModuleException --module=my-module
php artisan make:factory MyModuleFactory --module=my-module
php artisan make:job MyModuleJob --module=my-module
php artisan make:listener MyModuleListener --module=my-module
php artisan make:mail MyModuleMail --module=my-module
php artisan make:middleware MyModuleMiddleware --module=my-module
php artisan make:model MyModule --module=my-module
php artisan make:notification MyModuleNotification --module=my-module
php artisan make:observer MyModuleObserver --module=my-module
php artisan make:policy MyModulePolicy --module=my-module
php artisan make:provider MyModuleProvider --module=my-module
php artisan make:request MyModuleRequest --module=my-module
php artisan make:resource MyModule --module=my-module
php artisan make:rule MyModuleRule --module=my-module
php artisan make:seeder MyModuleSeeder --module=my-module
php artisan make:test MyModuleTest --module=my-module
Other Laravel Commands
In addition to adding a
--moduleoption to most
make:commands, we’ve also added the same option to the
db:seedcommand. If you pass the
--moduleoption to
db:seed, it will look for your seeder within your module namespace:
-
php artisan db:seed --module=my-module
will try to callModules\MyModule\Database\Seeders\DatabaseSeeder
-
php artisan db:seed --class=MySeeder --module=my-module
will try to callModules\MyModule\Database\Seeders\MySeeder
Vendor Commands
We can also add the
--moduleoption to commands in 3rd-party packages. The first package that we support is Livewire. If you have Livewire installed, you can run:
php artisan make:livewire counter --module=my-module
Comparison to nwidart/laravel-modules
Laravel Modules is a great package that’s been around since 2016 and is used by 1000's of projects. The main reason we decided to build our own module system rather than using
laravel-modulescomes down to two decisions:
- We wanted something that followed Laravel conventions rather than using its own directory structure/etc.
- We wanted something that felt “lighter weight”
If you are building a CMS that needs to support 3rd-party modules that can be dynamically enabled and disabled, Laravel Modules will be a better fit.
On the other hand, if you're mostly interested in modules for organization, and want to stick closely to Laravel conventions, we’d highly recommend giving InterNACHI/Modular a try!