Weave Code
Bagisto Package Generator Laravel Package
bagisto/bagisto-package-generator
An Artisan-based generator for Bagisto that scaffolds a complete package skeleton, including service providers, config, routes, views, and boilerplate, so developers can start building custom e-commerce extensions faster without manual setup.
Bagisto Package Generator
Frequently asked questions about Bagisto Package Generator
- What is bagisto/bagisto-package-generator used for?
- It is a development-time Artisan generator for Bagisto, the Laravel-based e-commerce platform. It scaffolds a complete package skeleton so you do not have to hand-create the composer manifest, service provider, config, routes, migrations, views, and translations. It is not a runtime dependency, a package manager, or an extension marketplace client.
- How do I install the Bagisto Package Generator?
- Add it to the host Bagisto application with composer require --dev bagisto/bagisto-package-generator. Because it only emits files during development, it belongs in require-dev and should not be part of your production dependency set. The Artisan command becomes available from your application root once Composer finishes.
- How do I create a new package with the generator?
- Run the package's Artisan command from the root of your Bagisto application and supply the vendor and package name for the extension you want to build. The command writes the scaffold into your packages directory, where Bagisto's package discovery can pick it up. Review the emitted files before committing, since past releases have shipped output fixes.
- What does the generated Bagisto package skeleton contain?
- The scaffold covers the standard package anatomy: composer.json, a service provider, a configuration file, routes, migrations, views, translations, and the usual directory structure. Test stubs are included but are empty by default. Treat the emitted tree as a draft and diff it against your strongest internal package before standardising on it.
- Which Bagisto and Laravel versions does this generator support?
- The current release line tracks Bagisto 2.x, with 2.1.2 as the referenced release, which implies active tracking of that branch. Laravel support follows whatever constraints Bagisto itself requires, so pin the generator version to match your core version. Check the package's composer.json for the exact constraint rather than assuming.
- Is the package generator a runtime dependency in production?
- No. It is a dev-time scaffolding tool, so it should be a require-dev entry and never load in production. Nothing it generates depends on the generator at runtime; the emitted service providers, config, and routes are ordinary Bagisto package code.
- Can I customise the stubs the generator uses?
- Generated output comes from stub templates shipped inside the package, and the practical path for teams whose conventions differ is to fork or vendor those stubs internally. Upstream does not guarantee a stable publishing mechanism for stubs, so a fork is the lower-risk option. Decide which convention wins, yours or the generator's, before a pilot rather than during one.
- Does it generate tests and CI configuration for new packages?
- It scaffolds empty test stubs, which can be misread as real coverage by people who were not involved in the scaffold. Require at least one meaningful test before a generated package is called done. The generator does not set up CI pipelines or static analysis beyond whatever boilerplate it ships.
- Can I use it on a plain Laravel app that isn't Bagisto?
- No. The output is shaped around Bagisto's package discovery, service providers, and directory conventions, so it contributes nothing to a standard Laravel project or a non-Bagisto application. Scope it explicitly to Bagisto extension development in your decision record.
- What happens if the generator stops being maintained?
- The project has a small star count and no dependents, which means single-maintainer risk and no ecosystem pressure to track the next Bagisto major. The mitigation is cheap: version-pin the generator, regenerate and diff on every Bagisto upgrade, and fork the stubs internally if upstream goes quiet. Regenerating and diffing is a better habit than trusting the output as correct by construction.
Weaver
How can I help you explore Laravel packages today?