Laravel Modelschema Laravel Package

Getting Started

• Start with GenerationService::generateModel() for a single model/component and GenerationService::generateAll() for batch generation.
• Look first at the generator return values: the package now treats returned json/yaml fragments as the source of truth for success in v1.3.1+.
• First day-to-day use case: wire generateAll() into an Artisan command or queued job, then use logs/metrics to confirm generated components instead of trusting a success key.
• If upgrading, verify you are on v1.3.1 or later before relying on failure counts in logs/metrics.

Implementation Patterns

• Wrap generation in a Laravel command or job, call GenerationService::generateModel() or generateAll(), and inspect the returned fragments directly when you need per-component results.
• Use generateAll() for bulk scaffolding and CI-style checks; use generateModel() when you need focused regeneration and clearer local debugging.
• For metrics, run generation through the service rather than calling generators directly so the fixed success detection in v1.3.1 is applied consistently.
• In tests, assert on returned json/yaml fragment presence rather than a success flag; this matches the service’s v1.3.1 behavior.
• For custom generators, keep returning json/yaml fragments in the expected shape so service-level logging and metrics classify results correctly.

Gotchas and Tips

• Pre-v1.3.1, generateAll() and generateModel() could report successful components as failed because they looked for a success key the generators never set. Do not carry that assumption into custom code or dashboards.
• Do not treat a missing success key as failure on v1.3.1+; check the returned json/yaml fragments instead.
• If logs or metrics still look wrong after upgrading, inspect the raw generator output first, then confirm the service is resolving the updated package version.
• When debugging batch runs, isolate a single generateModel() call and compare its returned fragments with the batch generateAll() summary.
• No config change is called out in v1.3.1; the main extension point is the generator output contract. Custom generators should return consistent fragments so logging and metrics remain meaningful.