はじめに
弊社のプロダクトはFuelPHPで書かれたものが多いのですが、これらをLaravelに移行するにあたり、可能な部分は機械的に変換することにしました。
今回取り上げるRectorPHPは、PHPコードのリファクタリングやコードの自動修正を行うためのなツールです。本記事では、RectorPHPを導入し、独自のリファクタリングルールを書く方法について紹介します。
RectorPHPのインストール
1. composerのインストール
まずはcomposerをインストールします。composerはPHPの依存関係管理ツールで、RectorPHPのインストールに必要なものです。
2. RectorPHPのインストール
次にRectorPHPをインストールします。以下のコマンドを使用して、RectorPHPをプロジェクトに追加します。開発環境でしか使わないのでdevオプションをつけています。
これにより、プロジェクトの composer.json ファイルが更新されます。
3. composer.jsonの更新内容
RectorPHPのインストールにより、composer.json ファイルに以下のような変更が加わります。ここではautoloadの指定も行っています。
これでRectorPHPがプロジェクトに追加されました。
独自ルールの書き方
RectorPHPを使用して独自のリファクタリングルールを書くには、以下の手順に従います。
1. ルールの作成
変換ルールのロジック部分を作成します。今回はInsertRule1.phpという名前で作成しました。
2. ルールの登録
最後に、作成したRectorクラスをrector.phpファイルに登録します。
InsertRule1::classをルールとして適用しています。
これで独自のリファクタリングルールがRectorPHPに追加されます。
3. ルールの実行
テスト実行をしてみます。パラメータにdry-runをつけるとテストになります。
このように置き換えられた様子を確認できます。
おわりに
本記事では、RectorPHPの導入と独自のリファクタリングルールの作成方法について紹介しました。RectorPHPを使用することで、PHPプロジェクトのコードベースを効率的に改善することができます。是非、ご自身のプロジェクトにも導入してみてください。
0コメント