mj-zana / maker

v2.1.0 2026-10-25 20:32 UTC

Requires

• php: ^8.5
• mj-zana/console: ^2.0
• mj-zana/core: ^2.0

Requires (Dev)

• mj-zana/ddd: ^2.0
• mj-zana/http: ^2.0
• mj-zana/mediator: ^2.0
• mj-zana/routing: ^2.0
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^11.5

MIT

• generator
• modules
• maker
• scaffolding
• zana

Published on Packagist.org on 2026-10-25 20:43 UTC

README

Code generators that follow the Zana module layout. Conventions produce plain, explicit code you own, not runtime magic. Requires PHP 8.5 or later.

composer require --dev mj-zana/maker

Generated classes use the namespace Modules\<Module> under modules/<Module>/, so map it in your composer.json:

"autoload": { "psr-4": { "Modules\\": "modules/" } }

Maker is a dev dependency, so register MakerServiceProvider (with ConsoleServiceProvider) only where it is installed, for example in bin/zana:

if (class_exists(\Zana\Maker\MakerServiceProvider::class)) {
    $builder->withProviders(\Zana\Maker\MakerServiceProvider::class);
}

Run the generators with APP_ENV=development. In production a compiled container that no longer matches the registrations is an error, and every make:* command changes the registrations.

Commands

php bin/zana make:module Patients                      # PatientsModule, its folders, and config/modules.php
php bin/zana make:feature Patients RegisterPatient     # command, #[Handles] handler, handler test
php bin/zana make:feature Patients FindPatient --query # query instead of command
php bin/zana make:entity Patients Patient              # aggregate root, PatientId, repository interface
php bin/zana make:controller Patients Measurements     # Presentation/Api/MeasurementsController, routed at /api/measurements

• Wiring: a generated module works straight away.
  • make:module writes two marker comments into the module class, one in register() and one in boot().
  • make:feature adds lines above them that register the handler and map it in the HandlerMap.
  • make:controller adds lines that register the controller and load its #[Route] attributes.
  • Generating the same thing twice wires it once. Keep the marker lines.
  • A module class without markers, such as one written by hand, is left alone. The command prints the lines to add instead.
• Names: module and class names are StudlyCase.
• config/modules.php: make:module adds the module there, creating the file if needed. The file must only return a list of ::class entries. Comments are kept.
• Existing files: they are never replaced. The command lists them and writes nothing. Add --force to replace them, or --dry-run to see what would be written.

Stubs

The built-in stubs live in this package's stubs/ folder. Copy one to <project>/stubs/<name>.stub to change it. Placeholders look like {{ name }}, and a placeholder the generator does not know is an error.

Stub	Placeholders
module	name, module, namespace
command, query, command-handler, query-handler	module, name, namespace, message
handler-test	the above, plus featureNamespace
entity, entity-id, repository	module, name, namespace
controller	module, name, namespace, path, route

The generated code uses mj-zana/ddd, mj-zana/mediator and mj-zana/routing. Install the ones your modules need.

License

MIT — see LICENSE.