Laravel Vibes

🚀 Laravel Vibes ドキュメント

Laravel Vibesは、Laravelアプリケーションでのツール管理やリソース割り当てを効率化するパッケージです。このドキュメントでは、インストール方法や使用方法、性能ベンチマークなどについて説明します。

🚀 クイックスタート

Laravel Vibesを使用するための基本的な手順を説明します。

1. Laravel Vibesパッケージのインストール

Composerを使用してLaravel Vibesをインストールします。

composer require projectsaturnstudios/laravel-vibes

2. サービスプロバイダの登録

config/app.phpファイルにTheAgencyをサービスプロバイダとして登録します。

'Projectsaturn\TheAgency\TheAgencyServiceProvider::class',

3. 設定ファイルの公開

以下のコマンドを実行して、設定ファイルをプロジェクトディレクトリに公開します。

php artisan vendor:publish --provider=Projectsaturn\TheAgency\TheAgencyServiceProvider

✨ 主な機能

Laravel Vibesの主な機能を紹介します。

ツールの作成と実行

VibeToolを継承したクラスを作成し、それを設定ファイルに登録することで、ツールを実行できます。

リソースの管理

Resourceクラスを使用して、アプリケーション内のリソースを管理できます。

性能ベンチマーク

メモリ使用量、応答時間、スループットなどの性能ベンチマークを行い、最適化することができます。

📦 インストール

Laravel Vibesをインストールするための詳細な手順を説明します。

1. Laravel Vibesパッケージのインストール

Composerを使用してLaravel Vibesをインストールします。

composer require projectsaturnstudios/laravel-vibes

2. サービスプロバイダの登録

config/app.phpファイルにTheAgencyをサービスプロバイダとして登録します。

'Projectsaturn\TheAgency\TheAgencyServiceProvider::class',

3. 設定ファイルの公開

以下のコマンドを実行して、設定ファイルをプロジェクトディレクトリに公開します。

php artisan vendor:publish --provider=Projectsaturn\TheAgency\TheAgencyServiceProvider

💻 使用例

基本的な使用法

最初のVibeツールを作成し、実行する方法を説明します。

1. 最初のVibeツールの作成

app/Toolsディレクトリに新しいツールクラスを作成し、VibeToolを継承します。

<?php

namespace App\Tools;

use Projectsaturn\Vibe\VibeTool;

class MyFirstTool extends VibeTool
{
    public function handle()
    {
        return "Hello, World!";
    }
}

2. 設定ファイルでのツールの登録

config/vibes.phpファイルにツールを追加します。

'App\Tools\MyFirstTool::class' => [
    'name' => 'my_first_tool',
],

3. Vibeツールの使用

サービスプロバイダを介してツールにアクセスします。

$vibe = $this->app->make('vibes');
$result = $vibe->runPrimitive(
    primitive: MyFirstTool::class,
    context: ['key' => 'value'],
    options: [
        'option1' => true,
        'option2' => 'string',
    ],
);

高度な使用法

リソースの作成と登録方法を説明します。

1. リソースの作成

app/Resourcesディレクトリに新しいリソースクラスを作成します。

<?php

namespace App\Resources;

use Projectsaturn\Vibe\Resource;

class MyResource extends Resource
{
    public function getPrimitive()
    {
        return 'my_resource_value';
    }
}

2. 設定ファイルでのリソースの登録

config/vibes.phpファイルにリソースを追加します。

'App\Resources\MyResource::class' => [
    'name' => 'my_resource',
],

📚 ドキュメント

Laravel Vibesの詳細なドキュメントを参照することができます。

互換性マトリックス

LaravelバージョンとLaravel Vibesの互換性については、Compatibility Matrixを参照してください。

トラブルシューティングガイド

エラーが発生した場合、Troubleshooting Guideを参照して問題を解決してください。

🔧 技術詳細

Laravel Vibesの技術的な詳細を説明します。

核心コンポーネント

1. TheAgency：すべてのVibeツールとサービスを管理します。
2. VibeTool：ツールの基本的なインターフェースと実行ロジックを定義します。
3. Resource：アプリケーション内のリソース割り当てと管理を行います。

実行フロー

1. ツールを初期化し、依存関係を注入します。
2. 入力コンテキストとオプションを処理します。
3. 結果を返すか、例外をスローします。

📄 ライセンス

Laravel VibesはMITライセンスの下で提供されています。詳細はLICENSEを参照してください。