【Laravel】artisanのstub:publishコマンドを解説

Laravel 10.x以降のartisanの「stub:publish」コマンドを解説します。

Description
Usage
Arguments
Options
Example
1. no options
2. existing
Source
1. 10.x
2. 11.x

Description

カスタマイズ可能なすべてのスタブ¹をstubsディレクトリに出力します。

artisanコマンドで作成されるファイルのテンプレート ↩︎

Usage

php artisan stub:publish [--existing] [--force]

Bash

Arguments

オプションはありません。

Options

オプション	省略形	必須	説明
existing	-	-	stubs/以下にあるファイルのみ上書き出力
force	-	-	既存のファイルを上書き

Example

no options

php artisan stub:publish

Bash

   INFO  Stubs published successfully.

Bash

$ ls stubs/
cast.inbound.stub          controller.nested.api.stub            enum.stub                   mail.stub                   notification.stub    resource-collection.stub
cast.stub                  controller.nested.singleton.api.stub  event.stub                  markdown-mail.stub          observer.plain.stub  resource.stub
class.invokable.stub       controller.nested.singleton.stub      factory.stub                markdown-notification.stub  observer.stub        rule.stub
class.stub                 controller.nested.stub                job.queued.stub             middleware.stub             pest.stub            scope.stub
console.stub               controller.plain.stub                 job.stub                    migration.create.stub       pest.unit.stub       seeder.stub
controller.api.stub        controller.singleton.api.stub         listener.queued.stub        migration.stub              policy.plain.stub    test.stub
controller.invokable.stub  controller.singleton.stub             listener.stub               migration.update.stub       policy.stub          test.unit.stub
controller.model.api.stub  controller.stub                       listener.typed.queued.stub  model.pivot.stub            provider.stub        trait.stub
controller.model.stub      enum.backed.stub                      listener.typed.stub         model.stub                  request.stub         view-component.stub

Bash

existing

既にstubs以下にあるファイルのみをLaravelデフォルトのもので上書きします。

php artisan stub:publish　--existing

Bash

   INFO  Stubs published successfully.

Bash

$ ls stubs/
test.stub

$ cat stubs/test.stub 
HOGE

$ php artisan stub:publish --existing

   INFO  Stubs published successfully.  

$ ls stubs
test.stub

$ cat stubs/test.stub 
<?php

namespace {{ namespace }};

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithFaker;
use Tests\TestCase;

class {{ class }} extends TestCase
{
    /**
     * A basic feature test example.
     */
    public function test_example(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}