Rector

Rector を Composer と一緒にインストールする

1. composer.json 内で、rector/rector 依存関係レコードを require キーまたは require-dev キーに追加します。パッケージ名とバージョンのコード補完を取得するには、Ctrl+Space を押します。

   "require-dev": { "rector/rector": "^0.15.13" },

2. 以下のいずれか 1 つを実行します:

   • エディターパネルの上部にあるインストールショートカットリンクをクリックします。

   • インストールされていない Composer パッケージインスペクションが有効になっている場合、PhpStorm は、現在インストールされていない宣言済みの依存関係をハイライトします。Alt+Enter を押して、特定の依存関係をインストールするか、すべての依存関係を一度にインストールするかを選択します。

Rector のインストールの詳細については、Rector のドキュメント(英語)を参照してください。

Rector 構成ファイルの追加と編集

1. 次のいずれかの方法で、rector.php テンプレートファイルをプロジェクトルートに追加します。

   • プロジェクトツールウィンドウでルートフォルダーを右クリックし、コンテキストメニューから新規 | rector.php ファイルを選択します。

     PhpStorm は、レクター初期化アクションを呼び出します。これにより、コマンドラインから実行される Rector の vendor/bin/rector init コマンドと同じ方法で rector.php ファイルが作成されます。

   • 検索ウィンドウ (Ctrl+Shift+A) から rector init アクションを検索して適用します。

     

   • ターミナルツールウィンドウから rector init コマンドを実行します。

     vendor/bin/rector init

2. 生成された rector.php ファイルを編集して、必要なレクター規則または規則セット(英語)を指定します。Ctrl+Space を押して、コード補完の提案を取得します。

   

フォルダーまたはファイルに対して Rector を実行する

• プロジェクトツールウィンドウで、Rector を実行するファイルまたはフォルダーを選択し、実行を選択します。| 選択のコンテキストメニューから <ファイルまたはフォルダー名> (Rector):

  

  PhpStorm はデフォルトの実行構成を生成し、構成で指定されたスコープで vendor/bin/rector process --dry-run コマンドを実行します。

rector.php から Rector を実行する

1. エディターで rector.php を開きます。

2. ガターで をクリックし、コンテキストメニューから実行 '<project name>' (Rector) を選択します。または、ファイル内の任意の場所から Ctrl+Shift+F10 を押します。

   

   rector.php ファイルで $rectorConfig->paths が定義されている場合、Rector は指定された範囲のフォルダーで実行されます。それ以外の場合、実行構成パスはプロジェクトルートの src/ フォルダーに自動的に設定されます。

カスタム Rector 構成を作成する

カスタム実行構成を作成するか、既存のデフォルト構成を編集して、たとえば追加の引数を vendor/bin/rector process コマンドに渡すことができます。

1. プロジェクトツールウィンドウで、ファイルまたはフォルダーを選択し、コンテキストメニューからさらに実行 / デバッグ | 実行構成の変更 | <ファイルまたはフォルダー名> (Rector) を選択します。

   あるいは、メインメニューで実行 | 実行構成の編集に移動し、 をクリックしてリストから Rector を選択します。

2. 開いた Rector の設定ダイアログで、必要に応じてフィールドを編集します。

1. 変更タブで、リストからファイルをクリックして開き、差分ビューアーで提案された変更をプレビューします。

   

2. 変更を適用するには、実行ツールウィンドウで関連ファイルのチェックボックスを選択し、適用をクリックします。