🕌

Laravel開発をするならLaravel Ideaを使おう

2023/02/20に公開2

こんにちは。
今回はPHPStormなどのJetbrains社のIDEで利用できるLaravel用の有料プラグインであるLaravel Ideaが結構いい感じなので軽く紹介。

https://laravel-idea.com/

年4,000円くらい掛かるので、正直手は出しにくいラインかと思いますが補完が強力なので、これくらいならいいかなといった感じ。一応、30日間のトライアルがあるのでそれを試してからでも。

インストール

インストール自体は簡単で、Preferencesのプラグインの一覧にLaravel Ideaは存在します。

基本的には下のLaravel Queryの高機能版って感じで、私の記憶では一緒にインストールされた気がします。ぶつかったりはしないのでもし入ってなかったら両方入れるのがよろし。

強力な補完機能を使おう

Laravel Ideaの個人的良いところはなんと言っても補完機能が強力なところです。(特にモデル)

まず知らないと損する機能です。ぜひ使いましょう。

まず補完をさせるためにはIDE Helperと同じようにヘルパーコードを生成する必要があるのですがShift + Cmd + .(WinだとShift + Ctrl + .) を選びましょう。

初回は設定項目が出てきます。

これは私の設定項目ですが、Fetch Data Fromはプロジェクトによって切り替えたほうが良いでしょう。マイグレーションからか、コネクションからかで選べます。

以降はショートカットを実行することでヘルパーが再生成されます。
新しいModelを追加した時や、アクセサーやミューテーターといったメソッドの追加を行って補完が効かない〜〜となった際にはショートカットを打つことですぐに解決できます。

便利なコード生成機能

Laravel Ideaには、結構便利なコード生成機能が付属しています。
コード生成する際には、Shift + Cmd + ,(WinだとShift + Ctrl + ,) でアクションメニューを開き、作りたい内容を書くと補完がされます。

例えば、以下はJson Resourceクラスを生成する画面です。

OptionalとしてEloquent Classを指定することでtoArrayメソッドの配列にEloquentクラスのカラム情報が自動的に挿入された状態でコード生成がされます。
同様に、Model Factory(Database Factory)でもいい感じに生成ができるので、面倒な記述の短縮になりますね。

設定画面

いくつかの設定は、Preferencesの言語&フレームワークのLaravel Ideaから変更ができます。
残念ながら日本語化はされていないため、英語を頑張って読みましょう・・・。

軽くですが、こちらの表記に関しての説明。

表記 内容
Laravel Idea Laravelのインストールディレクトリなど、基本の設定
Module System 利用するモジュールシステムの種類選択。基本的にはスタンダードでOK。詳しいことはこちら
Code Generation コード生成する際の基本設定
Code Generations コード生成の出力ディレクトリとか名前空間などの設定。ちなみにコード生成自体を修正するには設定のエディター/ファイル及びコードテンプレートコードタブに存在。
Custom Generations 独自のコード生成の設定
Laravel Packages いくつかの有名なパッケージ向けの設定。
Eloquent Eloquentに関する設定。すべて有効で良さそう。
Views Viewに関する基本設定。
Translation 翻訳に関する設定
Validation バリデーションの補完に関する設定
Helper Code IDE Helperの生成に関する設定
Suppression Laravel独自の機能による警告の抑制に関する設定。例えば静的ではないメソッドに対して静的にアクセスしたりなど、警告としてでなくて良い警告を抑制します。
Smart GoTo 定義ジャンプなどの際にいい感じにジャンプさせるための設定です。
Blade Bladeに関する設定
Other Settings その他の設定

さいごに

Laravel Ideaに関して軽く説明しましたがどうだったでしょうか。
今後も良さそうな機能があれば加筆していきたいお気持ち。

Discussion