gnahotelsolutions/laravel-package-tools

Laravel 包创建工具

维护者

详情

github.com/gnahotelsolutions/laravel-package-tools

主页

源代码

资助包维护！
spatie

安装: 38

依赖者: 1

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 132

1.2 2023-06-27 10:07 UTC

Requires

Requires (Dev)

MIT fab72ff5398e9e8ec31a2e59469da78aa1a3d912

  • Freek Van der Herten <freek.woop@spatie.be>

laravel-package-tools

This package is auto-updated.

Last update: 2024-09-27 12:57:57 UTC

README

Latest Version on Packagist Tests Total Downloads

此包包含一个 PackageServiceProvider，您可以在您的包中使用它轻松注册配置文件、迁移等。

以下是如何使用它的一个示例。

use GNAHotelSolutions\LaravelPackageTools\PackageServiceProvider;
use GNAHotelSolutions\LaravelPackageTools\Package;
use MyPackage\ViewComponents\Alert;
use GNAHotelSolutions\LaravelPackageTools\Commands\InstallCommand;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasViews()
            ->hasViewComponent('spatie', Alert::class)
            ->hasViewComposer('*', MyViewComposer::class)
            ->sharesDataWithAllViews('downloads', 3)
            ->hasTranslations()
            ->hasAssets()
            ->publishesServiceProvider('MyProviderName')
            ->hasRoute('web')
            ->hasMigration('create_package_tables')
            ->hasCommand(YourCoolPackageCommand::class)
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishAssets()
                    ->publishMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub();
            });
    }
}

在底层，它将执行必要的操作来注册必要的事项并使各种文件可发布。

支持我们

我们投入了大量资源来创建 一流的开放源代码包。您可以通过 购买我们的付费产品之一 来支持我们。

我们非常感谢您从您的家乡寄给我们一张明信片，说明您正在使用我们的哪些包。您可以在 我们的联系页面 上找到我们的地址。我们将发布所有收到的明信片在 我们的虚拟明信片墙上。

入门

此包对您应该如何构建您的包有明确的意见。为了轻松开始，请考虑使用 我们的 package-skeleton 仓库 来开始您的包。该骨架结构完美，可以与该包中的 PackageServiceProvider 无缝配合。

用法

在您的包中，您应该让您的服务提供程序扩展 Spatie\LaravelPackageTools\PackageServiceProvider。

use GNAHotelSolutions\LaravelPackageTools\PackageServiceProvider;
use GNAHotelSolutions\LaravelPackageTools\Package;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package) : void
    {
        $package->name('your-package-name');
    }
}

传递包名称到 name 是强制性的。

处理配置文件

要注册配置文件，您应该在您的包的 config 目录中创建一个以您的包名称命名的 php 文件。在此示例中，它应该在 <package root>/config/your-package-name.php。

如果您的包名称以 laravel- 开头，我们预计您的配置文件不包含该前缀。因此，如果您的包名称是 laravel-cool-package，则配置文件应命名为 cool-package.php。

要注册该配置文件，请在 configurePackage 方法中调用 $package 上的 hasConfigFile()。

$package
    ->name('your-package-name')
    ->hasConfigFile();

hasConfigFile 方法还将使配置文件可发布。您的包的用户将能够使用此命令发布配置文件。

php artisan vendor:publish --tag=your-package-name-config

如果您的包有多个配置文件，您可以将它们的名称作为数组传递给 hasConfigFile

$package
    ->name('your-package-name')
    ->hasConfigFile(['my-config-file', 'another-config-file']);

处理视图

您的包提供的任何视图都应放置在 <package root>/resources/views 目录中。

您可以使用 hasViews 命令注册这些视图。

$package
    ->name('your-package-name')
    ->hasViews();

这将注册您的视图到 Laravel。

如果您有一个视图 <package root>/resources/views/myView.blade.php，您可以像这样使用它：view('your-package-name::myView')。当然，您也可以使用子目录来组织您的视图。位于 <package root>/resources/views/subdirectory/myOtherView.blade.php 的视图可以使用 view('your-package-name::subdirectory.myOtherView') 使用。

使用自定义视图命名空间

您可以将自定义视图命名空间传递给 hasViews 方法。

$package
    ->name('your-package-name')
    ->hasViews('custom-view-namespace');

现在，您可以使用以下方式使用包中的视图

view('custom-view-namespace::myView');

发布视图

调用 hasViews 将使视图可发布。您的包的用户将能够使用此命令发布视图

php artisan vendor:publish --tag=your-package-name-views

注意

如果您使用自定义视图命名空间，则应更改您的发布命令如下

php artisan vendor:publish --tag=custom-view-namespace-views

与视图共享全局数据

您可以使用 sharesDataWithAllViews 方法与所有视图共享数据。这将使共享变量对所有视图都可用。

$package
    ->name('your-package-name')
    ->sharesDataWithAllViews('companyName', 'Spatie');

处理 Blade 视图组件

您包提供的任何 Blade 视图组件应放置在 <package root>/src/Components 目录中。

您可以使用 hasViewComponents 命令注册这些视图。

$package
    ->name('your-package-name')
    ->hasViewComponents('spatie', Alert::class);

这将注册您的视图组件到 Laravel 中。对于 Alert::class，在视图中可以引用为 <x-spatie-alert />，其中 spatie 是注册时提供的名称前缀。

调用 hasViewComponents 也会使视图组件可发布，并发布到 app/Views/Components/vendor/<package name>。

您的包的用户可以使用此命令发布视图组件

php artisan vendor:publish --tag=your-package-name-components

与视图组合器一起工作

您可以使用 hasViewComposers 方法注册您的项目使用的任何视图组合器。您也可以注册一个接收 $view 参数的回调而不是类名。

要注册所有视图的组合器，请使用通配符作为视图名称 '*'。

$package
    ->name('your-package-name')
    ->hasViewComposer('viewName', MyViewComposer::class)
    ->hasViewComposer('*', function($view) { 
        $view->with('sharedVariable', 123); 
    });

与翻译一起工作

您包提供的任何翻译应放置在 <package root>/resources/lang/<language-code> 目录中。

您可以使用 hasTranslations 命令注册这些翻译。

$package
    ->name('your-package-name')
    ->hasTranslations();

这将注册翻译到 Laravel 中。

假设您将此翻译文件保存到 <package root>/resources/lang/en/translations.php...

return [
    'translatable' => 'translation',
];

...您的包和用户可以使用以下方式检索翻译

trans('your-package-name::translations.translatable'); // returns 'translation'

如果您的包名称以 laravel- 开头，那么在上面的示例中应该省略。

以翻译字符串作为键编码，您应该在 <package root>/resources/lang/<language-code>.json 中创建 JSON 文件。

例如，创建 <package root>/resources/lang/it.json 文件如下

{
    "Hello!": "Ciao!"
}

...输出为...

trans('Hello!');

...如果应用程序使用意大利语，输出将是 Ciao!

调用 hasTranslations 也会使翻译可发布。您的包的用户可以使用此命令发布翻译

php artisan vendor:publish --tag=your-package-name-translations

与资产一起工作

您包提供的任何资产应放置在 <package root>/resources/dist/ 目录中。

您可以使用 hasAssets 方法使这些资产可发布。

$package
    ->name('your-package-name')
    ->hasAssets();

您的包的用户可以使用此命令发布资产

php artisan vendor:publish --tag=your-package-name-assets

这将把资产复制到应用程序中您的包安装位置的 public/vendor/<your-package-name> 目录中。

与迁移一起工作

PackageServiceProvider 假设任何迁移都放置在这个目录中： <package root>/database/migrations。在该目录内，您可以放置任何迁移。

要注册迁移，应将不带扩展名的迁移名称传递给 hasMigration 表。

如果您的迁移文件名为 create_my_package_tables.php.stub，可以按如下方式注册它们

$package
    ->name('your-package-name')
    ->hasMigration('create_my_package_tables');

如果您的包包含多个迁移文件，只需多次调用 hasMigration 或使用 hasMigrations。

$package
    ->name('your-package-name')
    ->hasMigrations(['my_package_tables', 'some_other_migration']);

调用 hasMigration 也会使迁移可发布。您的包的用户可以使用此命令发布迁移

php artisan vendor:publish --tag=your-package-name-migrations

如预期的那样，发布的迁移文件将使用当前日期和时间作为前缀。

您还可以启用迁移，以便无需用户发布即可注册

$package
    ->name('your-package-name')
    ->hasMigrations(['my_package_tables', 'some_other_migration'])
    ->runsMigrations();

与可发布的服务提供程序一起工作

某些包需要将示例服务提供程序复制到 Laravel 应用的 app\Providers 目录。例如，考虑 laravel/horizon 包，它将一个 HorizonServiceProvider 复制到您的应用，并带有一些合理的默认值。

$package
    ->name('your-package-name')
    ->publishesServiceProvider($nameOfYourServiceProvider);

将要复制到应用程序的文件应存储在您的包中的 /resources/stubs/{$nameOfYourServiceProvider}.php.stub。

当您的包安装到应用程序中时，运行此命令...

php artisan vendor:publish --tag=your-package-name-provider

...将您的包中的 /resources/stubs/{$nameOfYourServiceProvider}.php.stub 复制到用户的应用程序中的 app/Providers/{$nameOfYourServiceProvider}.php。

注册命令

您可以使用 hasCommand 函数注册您的包提供的任何命令。

$package
    ->name('your-package-name')
    ->hasCommand(YourCoolPackageCommand::class);

如果你的包提供多个命令，你可以多次使用hasCommand，或者向hasCommands传递一个数组。

$package
    ->name('your-package-name')
    ->hasCommands([
        YourCoolPackageCommand::class,
        YourOtherCoolPackageCommand::class,
    ]);

添加安装命令

与其让用户手动发布配置文件、迁移和其他文件，不如添加一个一次性完成所有工作的安装命令。Laravel Horizon 和 Livewire 等包提供了此类命令。

当使用 Laravel 包工具时，你不必自己编写 InstallCommand。相反，你可以简单地调用 hasInstallCommand 并使用闭包来配置它。以下是一个示例。

use GNAHotelSolutions\LaravelPackageTools\PackageServiceProvider;
use GNAHotelSolutions\LaravelPackageTools\Package;
use GNAHotelSolutions\LaravelPackageTools\Commands\InstallCommand;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasMigration('create_package_tables')
            ->publishesServiceProvider('MyServiceProviderName')
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishAssets()
                    ->publishMigrations()
                    ->askToRunMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
            });
    }
}

设置好后，包用户可以调用此命令

php artisan your-package-name:install

使用上述代码，该命令将

  • 发布配置文件
  • 发布资源
  • 发布迁移
  • 将包中的 /resources/stubs/MyProviderName.php.stub 复制到 app/Providers/MyServiceProviderName.php，并在 config/app.php 中注册该提供者
  • 询问是否现在运行迁移
  • 提示用户在浏览器中打开 https://github.com/'your-vendor/your-repo-name' 以进行星标

你还可以在 InstallCommand 上调用 startWith 和 endWith。它们将分别在运行 php artisan your-package-name:install 时的开始和结束时执行。你可以使用此功能执行额外的工作或显示额外的输出。

use use GNAHotelSolutions\LaravelPackageTools\Commands\InstallCommand;

public function configurePackage(Package $package): void
{
    $package
        // ... configure package
        ->hasInstallCommand(function(InstallCommand $command) {
            $command
                ->startWith(function(InstallCommand $command) {
                    $command->info('Hello, and welcome to my great new package!');
                })
                ->publishConfigFile()
                ->publishAssets()
                ->publishMigrations()
               ->askToRunMigrations()
                ->copyAndRegisterServiceProviderInApp()
                ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
                ->endWith(function(InstallCommand $command) {
                    $command->info('Have a great day!');
                })
        });
}

与路由一起工作

PackageServiceProvider 假设任何路由文件都放置在这个目录中：<package root>/routes。在该目录中，你可以放置任何路由文件。

要注册你的路由，你应该将不带扩展名的路由名称传递给 hasRoute 方法。

如果你的路由文件名为 web.php，你可以这样注册它们

$package
    ->name('your-package-name')
    ->hasRoute('web');

如果你的包包含多个路由文件，只需多次调用 hasRoute 或使用 hasRoutes。

$package
    ->name('your-package-name')
    ->hasRoutes(['web', 'admin']);

使用生命周期钩子

你可以在这些方法之一中放置包启动时需要的任何自定义逻辑

  • registeringPackage：在 PackageServiceProvider 的 register 方法的开始时调用
  • packageRegistered：在 PackageServiceProvider 的 register 方法结束时调用
  • bootingPackage：在 PackageServiceProvider 的 boot 方法的开始时调用
  • packageBooted：在 PackageServiceProvider 的 boot 方法结束时调用

测试

composer test

变更日志

请参阅CHANGELOG 以获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING 以获取详细信息。

安全漏洞

请审查我们的安全策略了解如何报告安全漏洞。

鸣谢

许可协议

MIT 许可协议 (MIT)。请参阅许可文件以获取更多信息。