dcblogdev/laravel-module-generator

从模板生成Laravel模块。

v2.0.4 2024-08-10 18:24 UTC

This package is auto-updated.

Last update: 2024-09-10 18:40:47 UTC


README

有一个Discord社区。 https://discord.gg/VYau8hgwrm 对于快速帮助,请在合适的频道提问。

Logo

Laravel包,用于从模板生成Laravel模块

要求

PHP 8.2+ 安装Laravel Modules包 https://github.com/nWidart/laravel-modules

视频演示

Intro video

https://www.youtube.com/watch?v=BwYzfb9Fa8A&t=2s

安装

您可以通过composer安装此包

composer require dcblogdev/laravel-module-generator

发布configstubs

php artisan vendor:publish --provider="Dcblogdev\ModuleGenerator\ModuleGeneratorServiceProvider"

这将发布一个module-generator.php配置文件

它包含

'template' => [
    'Breeze - Blade - CRUD Web & API' => 'stubs/module-generator/breeze-crud-full',
    'Breeze - Blade - CRUD Web only' => 'stubs/module-generator/breeze-crud-web',
    'Breeze - Blade - CRUD API only' => 'stubs/module-generator/breeze-crud-api'
],
'ignore_files' => ['module.json']

默认情况下,stubs将位于stubs/module-generator,您可以通过添加文件夹并更新配置文件来添加您的路径。

用法

php artisan module:build
300550938-529c214d-a02a-4577-8904-c865b2f41f7e

{module?} 是您要创建的模块名称。如果您不提供名称,您将需要输入一个。

{template?} 是您要使用的模板名称。如果您不提供名称,您将需要输入一个。

php artisan module:build Contacts "Breeze - CRUD API only"

创建模块后,启用它

php artisan module:enable ModuleName

然后运行

composer dump-autoload

创建或更新stubs文件。文件名和内容应包含占位符,例如 ModulesController 将替换为您的名称 + Controller。例如,当命令执行时,将变为 ContactsController

占位符

这些占位符在运行 php artisan module:build 时用提供的名称替换。

用于文件名

Module = 模块名称,例如 Contacts

module = 模块名称(小写),例如 contacts

module_plural = 模块复数名称(小写),例如demo变为 demos

Model = 模型名称,例如 Contact

model = 模型名称(小写),例如 contact

仅用于文件内部

{Module} = 模块名称,例如 PurchaseOrders

{module} = 模块名称(小写),例如 purchaseOrder

{module_} = 模块名称(带下划线),例如 purchase_orders

module_plural = 模块复数名称(小写),例如demo变为 demos

{module-} = 模块名称(带连字符),例如 purchase-orders

{module } = 模块名称(首字母大写之间有空格),例如 PurchaseOrders 变为 Purchase Orders

{Model} = 模型名称,例如 PurchaseOrder

{model} = 模型名称(小写),例如 purchaseOrder

{model_} = 模型名称(带下划线),例如 purchase_orders

{model-} = 模型名称(带连字符),例如 purchase-orders

{model } = 模型名称(首字母大写之间有空格),例如 PurchaseOrder 变为 Purchase Order

贡献

欢迎贡献,并将得到充分认可。

通过Github的拉取请求接受贡献。

拉取请求

  • 记录任何行为变化 - 确保readme.md和任何其他相关文档保持最新。

  • 考虑我们的发布周期 - 我们尝试遵循SemVer v2.0.0。随机破坏公共API不是可选项。

  • 每个特性一个拉取请求 - 如果您想做更多的事情,请发送多个拉取请求。

安全

如果您发现任何与安全相关的问题,请通过电子邮件发送至 dave@dcblog.dev,而不是使用问题跟踪器。

许可证

许可证。有关更多信息,请参阅许可证文件