subham-jobanputra/laravel-package-tools

用于创建Laravel包的工具

维护者

详细信息

github.com/subham-jobanputra/laravel-package-tools

主页

源代码

资助包维护！
spatie

安装: 2

依赖: 1

建议者: 0

安全: 0

星星: 0

关注者: 0

分支: 132

2.0.2 2024-03-20 08:56 UTC

Requires

Requires (Dev)

MIT ab6725a1a9d9d4a634024ebb7d0850e899c8d1dd

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

spatielaravel-package-tools

This package is auto-updated.

Last update: 2024-09-20 09:58:11 UTC

README

Latest Version on Packagist Tests Total Downloads

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

以下是一个使用示例。

use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;
use MyPackage\ViewComponents\Alert;
use Spatie\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 Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\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); 
    });

与Inertia组件协作

您包提供的任何.vue或.jsx文件都应该放置在<package root>/resources/js/Pages目录中。

您可以使用hasInertiaComponents命令来注册这些组件。

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

这将注册您的组件到Laravel。

用户应手动或使用安装命令来发布Inertia组件才能使用它们。

如果您有一个Inertia组件<package root>/resources/js/Pages/myComponent.vue，您可以使用它如下：Inertia::render('YourPackageName/myComponent')。当然，您也可以使用子目录来组织您的组件。

发布Inertia组件

调用hasInertiaComponents也将使Inertia组件可发布。您的包的用户可以使用此命令发布视图组件

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

此外，Inertia组件可以通过您的包中的安装命令方便地使用

与翻译协作

您包提供的任何翻译都应该放置在<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 Package Tools 时，您不需要自己编写 InstallCommand。相反，您可以简单地调用 hasInstallCommand 并使用闭包进行配置。以下是一个示例。

use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;
use Spatie\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 Spatie\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

变更日志

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

贡献

请参阅贡献指南以获取详细信息。

安全漏洞

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

鸣谢

许可证

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