base on Modularize your Laravel application <img alt="Modular" src="art/modular.png" width="100%" /> # `internachi/modular` <div> <a href="https://github.com/InterNACHI/modular/actions/workflows/phpunit.yml" target="_blank"> <img src="https://github.com/InterNACHI/modular/actions/workflows/phpunit.yml/badge.svg" alt="Build Status" /> </a> <a href="https://codeclimate.com/github/InterNACHI/modular/test_coverage" target="_blank"> <img src="https://api.codeclimate.com/v1/badges/dd927802d52f4f75ea6c/test_coverage" alt="Coverage Status" /> </a> <a href="https://packagist.org/packages/internachi/modular" target="_blank"> <img src="https://poser.pugx.org/internachi/modular/v/stable" alt="Latest Stable Release" /> </a> <a href="./LICENSE" target="_blank"> <img src="https://poser.pugx.org/internachi/modular/license" alt="MIT Licensed" /> </a> <a href="https://twitter.com/inxilpro" target="_blank"> <img src="https://img.shields.io/twitter/follow/inxilpro?style=social" alt="Follow @inxilpro on Twitter" /> </a> <a href="https://any.dev/@chris" target="_blank"> <img src="https://img.shields.io/mastodon/follow/109584001693739813?domain=https%3A%2F%2Fany.dev&style=social" alt="Follow @[email protected] on Mastodon" /> </a> </div> `internachi/modular` is a module system for Laravel applications. It uses [Composer path repositories](https://getcomposer.org/doc/05-repositories.md#path) for autoloading, and [Laravel package discovery](https://laravel.com/docs/11.x/packages#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](https://laravel.com/docs/11.x/packages), and follow existing Laravel conventions. - [Walkthrough Video](#walkthrough-video) - [Installation](#installation) - [Usage](#usage) - [Comparison to `nwidart/laravel-modules`](#comparison-to-nwidartlaravel-modules) ## Walkthrough Video [](https://internachi.wistia.com/medias/pivaxithl7?wvideo=pivaxithl7) ## 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.json` file. The first entry registers `./app-modules/my-module/` as a [path repository](https://getcomposer.org/doc/05-repositories.md#path), 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 `Modules` test suite to your `phpunit.xml` file (if one exists) and update your [PhpStorm Laravel plugin](https://plugins.jetbrains.com/plugin/7532-laravel) 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-dump` scripts in your application's `composer.json` file. ## 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 - Blade components will be auto-discovered - Event listeners will be auto-discovered ### 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 (like `phpunit.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](https://laravel.com/docs/11.x/artisan#stub-customization) and everything else Laravel provides: - `php artisan make:cast MyModuleCast --module=[module name]` - `php artisan make:controller MyModuleController --module=[module name]` - `php artisan make:command MyModuleCommand --module=[module name]` - `php artisan make:component MyModuleComponent --module=[module name]` - `php artisan make:channel MyModuleChannel --module=[module name]` - `php artisan make:event MyModuleEvent --module=[module name]` - `php artisan make:exception MyModuleException --module=[module name]` - `php artisan make:factory MyModuleFactory --module=[module name]` - `php artisan make:job MyModuleJob --module=[module name]` - `php artisan make:listener MyModuleListener --module=[module name]` - `php artisan make:mail MyModuleMail --module=[module name]` - `php artisan make:middleware MyModuleMiddleware --module=[module name]` - `php artisan make:model MyModule --module=[module name]` - `php artisan make:notification MyModuleNotification --module=[module name]` - `php artisan make:observer MyModuleObserver --module=[module name]` - `php artisan make:policy MyModulePolicy --module=[module name]` - `php artisan make:provider MyModuleProvider --module=[module name]` - `php artisan make:request MyModuleRequest --module=[module name]` - `php artisan make:resource MyModule --module=[module name]` - `php artisan make:rule MyModuleRule --module=[module name]` - `php artisan make:seeder MyModuleSeeder --module=[module name]` - `php artisan make:test MyModuleTest --module=[module name]` #### Other Laravel Commands In addition to adding a `--module` option to most `make:` commands, we’ve also added the same option to the `db:seed` command. If you pass the `--module` option to `db:seed`, it will look for your seeder within your module namespace: - `php artisan db:seed --module=[module name]` will try to call `Modules\MyModule\Database\Seeders\DatabaseSeeder` - `php artisan db:seed --class=MySeeder --module=[module name]` will try to call `Modules\MyModule\Database\Seeders\MySeeder` #### Vendor Commands We can also add the `--module` option 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=[module name]` #### Blade Components Your [Laravel Blade components](https://laravel.com/docs/blade#components) will be automatically registered for you under a [component namespace](https://laravel.com/docs/9.x/blade#manually-registering-package-components). A few examples: | File | Component | |--------------------------------------------------------------------|--------------------------------| | `app-modules/demo/src/View/Components/Basic.php` | `<x-demo::basic />` | | `app-modules/demo/src/View/Components/Nested/One.php` | `<x-demo::nested.one />` | | `app-modules/demo/src/View/Components/Nested/Two.php` | `<x-demo::nested.two />` | | `app-modules/demo/resources/components/anonymous.blade.php` | `<x-demo::anonymous />` | | `app-modules/demo/resources/components/anonymous/index.blade.php` | `<x-demo::anonymous />` | | `app-modules/demo/resources/components/anonymous/nested.blade.php` | `<x-demo::anonymous.nested />` | #### Customizing the Default Module Structure When you call `make:module`, Modular will scaffold some basic boilerplate for you. If you would like to customize this behavior, you can do so by publishing the `app-modules.php` config file and adding your own stubs. Both filenames and file contents support a number of placeholders. These include: - `StubBasePath` - `StubModuleNamespace` - `StubComposerNamespace` - `StubModuleNameSingular` - `StubModuleNamePlural` - `StubModuleName` - `StubClassNamePrefix` - `StubComposerName` - `StubMigrationPrefix` - `StubFullyQualifiedTestCaseBase` - `StubTestCaseBase` ## Comparison to `nwidart/laravel-modules` [Laravel Modules](https://nwidart.com/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-modules` comes down to two decisions: 1. We wanted something that followed Laravel conventions rather than using its own directory structure/etc. 2. 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! ", Assign "at most 3 tags" to the expected json: {"id":"8092","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"