README

此包允许您轻松创建和管理自己的本地 sebastienheyd/boilerplate 包。

安装

通过 Composer

composer require sebastienheyd/boilerplate-packager --dev

可选：发布配置文件

php artisan vendor:publish --tag=boilerplate-packager

用法

默认情况下，当没有参数调用 boilerplate:packager 时，将显示帮助信息。

php artisan boilerplate:packager

创建新包

默认情况下，每个包都将使用 sebastienheyd/boilerplate-package-skeleton 生成。注意，您可以通过在 配置文件 中设置 skeleton 值来使用本地路径。

您也可以通过修改 配置文件 中的值来修改默认的创建数据（作者、电子邮件、描述、许可证）

php artisan boilerplate:packager create

或者您可以直接在命令行中定义包名

php artisan boilerplate:packager create my-vendor/my-package 

在此示例中，在询问有关作者、电子邮件、描述、许可证和资源的几个问题后，命令将在 packages/my-vendor/my-package 目录中加载骨架包。然后，它将要求在项目中使用本地包，并在 vendor 目录中创建一个指向本地包的符号链接。之后，您只需在刚刚安装的包中进行编码即可。

选项

您可以使用 --dev 选项创建包，将其添加到 composer.json 中的 require-dev 部分

要求一个包

您可以从 Packagist 检索一个包，或者通过提供 Git 仓库 URL。

php artisan boilerplate:packager require my-vendor/my-package
php artisan boilerplate:packager require https://github.com/my-vendor/my-package
php artisan boilerplate:packager require git@github.com/my-vendor/my-package

这将克隆包到 packages 文件夹，并通过 Composer 进行要求。

选项

您可以使用 --dev 选项要求一个包，将其添加到 composer.json 中的 require-dev 部分

移除本地包

您可以使用 remove 命令来移除本地包。如果您在没有任何包名称的情况下调用命令，您将被要求选择要删除的包。

php artisan boilerplate:packager remove

您也可以直接定义包名

php artisan boilerplate:packager remove my-vendor/my-package 

这将从您的项目中删除本地包。命令将要求确认删除本地文件夹。

列出本地包

php artisan boilerplate:packager list

这将显示一个表格，其中包含所有本地包（已安装或未安装）。

为 CRUD 生成文件

此命令将为包生成的表生成模板、控制器、视图、菜单和翻译。

为此，在通过 create 命令创建您的包后，在包中创建迁移，然后运行它们以在数据库中生成表。之后，运行 crud 命令，指定包含迁移的包。

php artisan boilerplate:packager crud

您也可以直接定义包名

php artisan boilerplate:packager crud my-vendor/my-package 

如果外键指向包中不存在的模型，则命令将要求您输入与所需模型相关的命名空间。

请注意，如果包中已存在文件，它们将被覆盖。

您可以使用 --only 选项和以下关键字之一或多个来生成指定的资源：model、routes、lang、permissions、controller、menu、views

php artisan boilerplate:packager crud my-vendor/my-package --only=views --only=routes

有时您的包会使用前缀表，为了避免生成带前缀的文件，可以使用--prefix选项将其删除。

php artisan boilerplate:packager crud my-vendor/my-package --prefix=myprefix__

测试和编码标准

此包附带测试，只需启动即可运行测试。

make test

编码标准也可以通过使用phpcs进行检查。

make cs

贡献

有关详细信息，请参阅contributing.md。

安全

如果您发现任何与安全相关的问题，请通过电子邮件发送给作者，而不是使用问题跟踪器。

鸣谢

• Sébastien HEYD
• 所有贡献者

许可证

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