[protibimbok]

📑 Description

Implements goravel/goravel#1030

✅ Checks

• Added test cases for my code

[codecov]

Codecov Report

❌ Patch coverage is 99.36125% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.64%. Comparing base (82c6a43) to head (36cf220).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
packages/modify/utils.go	98.00%	2 Missing ⚠️
packages/modify/with_slice_actions.go	90.00%	2 Missing ⚠️
modular/console/init_command.go	98.27%	1 Missing ⚠️
modular/console/list_command.go	98.59%	1 Missing ⚠️
modular/console/module_make_command.go	99.35%	1 Missing ⚠️
modular/publish.go	99.12%	1 Missing ⚠️
modular/static.go	97.05%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1613      +/-   ##
==========================================
+ Coverage   75.72%   77.64%   +1.92%     
==========================================
  Files         426      438      +12     
  Lines       28275    29631    +1356     
==========================================
+ Hits        21410    23008    +1598     
+ Misses       6864     6622     -242     
  Partials        1        1              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[hwbrzzl]

@goravel-agent analyze

[hwbrzzl]

@protibimbok Could you please update the PR description to show the new feature?

[goravel-agent]

🔎 PR analysis

1. Breaking changes — 5 found

• contracts/database/migration.Migrator gained CreateIn(dir, name, modelName) → 1 in-repo implementor plus its mock; every implementor outside the module stops compiling → add the method and return Create(name, modelName) when dir is empty.
• contracts/foundation.Application gained MakeModular() modular.Registry → 1 in-repo implementor plus its mock; test fakes outside the module stop compiling → return nil where no registry is bound.
• contracts/foundation.ApplicationBuilder gained WithModules(func() []modular.Module) → 1 in-repo implementor plus its mock; builder fakes outside the module stop compiling → return the receiver unchanged.
• vite/console.NewInputsCommand gained a fourth argument, modules modular.Registry → 1 caller and 11 test call sites → pass app.MakeModular().
• ProviderRepository now keys a provider by its full package path instead of its short type name → 0 known callers; an app that registers two providers with the same short name boots both, where one was silently dropped → nothing to change.

2. How to use it

Module registration:

Before: not available — a package's routes, config, views, migrations, jobs and commands were each wired by hand in bootstrap/app.go and one service provider of its own.

After: WithModules takes the module list; every capability interface a module implements (Routes, ApiRoutes, Config, Views, Translations, Migrations, Seeders, Commands, Jobs, Events, Schedule, GlobalMiddleware, ViteEntries, ViteAliases, Static, ServiceProviders) is merged into the build, and Order() decides the order.

// bootstrap/modules.go
func Modules() []modular.Module {
	return []modular.Module{
		&blog.Module{},
	}
}

// bootstrap/app.go
func Boot() contractsfoundation.Application {
	return foundation.Setup().
		WithConfig(config.Boot).
		WithModules(Modules).
		Start()
}

The --module make commands:

Before: make:* wrote every file under the app's own paths, so make:controller BlogController produced app/http/controllers/blog_controller.go.

After: --module=blog writes into the module instead, modules/blog/http/controllers/blog_controller.go, and make:console, make:job, make:seeder, make:migration and make:provider also append the new type to the module's Commands(), Jobs(), Seeders(), Migrations() or ServiceProviders(). A third-party module is refused, only the app's own modules take generated files.

Module scaffolding and commands:

Before: not available — the directory, the config file and the bootstrap entry were written by hand.

After: modular:init writes modules/.gitkeep, config/modular.go and bootstrap/modules.go, adds .WithModules(Modules) to the chain and a //go:generate go run . artisan modular:publish line to main.go; make:module blog scaffolds a module and registers it in that list; modular:list (--json) prints each module with its capabilities; modular:publish copies a third-party module's sources into modules/blog.

Module routes and static files:

Before: not available — routes and static files came only from WithRouting and the app's own router.

After: Routes(router) runs inside the modular.routes.web group and ApiRoutes(router) inside modular.routes.api, with prefix "" and "api" and the middleware listed in config/modular.go; Static() maps a URL prefix to a directory and those files are served before the module routes.

func (m *Module) Routes(router route.Router) {
	router.Get("/blog", func(ctx http.Context) http.Response {
		return ctx.Response().Success().Json(http.Json{"module": "blog"})
	})
}

Module views and translations:

Before: not available — a package mounted its views and translations through a service provider of its own with LoadViewsFromFS.

After: Views() is mounted under the module name, so the template is rendered as blog/index.tmpl; Translations() turns en/messages.json into the group blog/messages, read as blog/messages.welcome. The app's own lang filesystem still wins for a name both define.

//go:embed resources/views
var views embed.FS

func (m *Module) Views() fs.FS {
	return views
}

Vite aliases:

Before: {{ vite }}, {{ viteAsset }} and Vite.Tags took a path from the project root; a leading @ was not resolved.

After: the alias table goravel-vite-plugin publishes — manifest key goravel:aliases for a build, the hot file in dev — resolves @blog/... to the module's directory; ViteEntries() are built even when no view references them, and ViteAliases() adds keys such as @blog-assets.

tags, err := facades.Vite().Tags("@blog/resources/js/app.js")

3. Laravel comparison — Deviates

No Laravel equivalent — WithModules(func() []modular.Module) (laravel/framework@13.x) — Laravel has no module unit; the closest concept is a package service provider in bootstrap/providers.php, so a feature that is one module here is a provider plus N method calls there, https://laravel.com/docs/packages#service-providers

func Modules() []modular.Module {
	return []modular.Module{&blog.Module{}}
}

Partially matches — Routes(router route.Router) in the modular.routes.web group ↔ loadRoutesFrom(__DIR__.'/../routes/web.php') (laravel/framework@13.x) — same job, a package's routes get a group; Laravel's prefix and middleware are written in the routes file, Goravel's are read from config/modular.go, https://laravel.com/docs/packages#routes

func (m *Module) Routes(router route.Router) {
	router.Get("/blog", func(ctx http.Context) http.Response {
		return ctx.Response().Success().Json(http.Json{"module": "blog"})
	})
}

$this->loadRoutesFrom(__DIR__.'/../routes/web.php');

Deviates — blog/index.tmpl ↔ courier::dashboard (laravel/framework@13.x) — same job, a different address: a directory prefix here, a :: namespace there; Laravel also checks resources/views/vendor/courier first so the app can override a package view, Goravel has no override directory, https://laravel.com/docs/packages#views

return ctx.Response().View().Make("blog/index.tmpl")

return view('courier::dashboard');

Deviates — blog/messages.welcome ↔ courier::messages.welcome (laravel/framework@13.x) — same lookup, a different separator, and a module cannot contribute the * group (en.json) Laravel allows, https://laravel.com/docs/packages#translations

facades.Lang(ctx).Get("blog/messages.welcome")

echo __('courier::messages.welcome');

No Laravel equivalent — facades.Vite().Tags("@blog/resources/js/app.js") (laravel/framework@13.x) — no Laravel call resolves a Vite alias on the server; the closest concept is resolve.alias in vite.config.js, which only Vite itself reads, https://laravel.com/docs/vite#aliases

tags, err := facades.Vite().Tags("@blog/resources/js/app.js")