File Watchers

1. 設定ダイアログ（Ctrl+Alt+S）で、ツールの File Watchers をクリックします。File Watchers ページが開き、このプロジェクトと IDE ですでに構成されているファイルウォッチャーのリストが表示されます。

2. をクリックして、ファイル監視を作成したい定義済みテンプレートを選択します。選択は使用しようとしているツールに依存します。一覧にないツールを使用するには、カスタムを選択してください。新規ウォッチャーダイアログが開きます。

3. 名前フィールドに、File Watcher の名前を入力します。デフォルトでは、PhpStorm は選択された定義済みテンプレートの名前を提案します。

1. ファイルタイプリストから、予想される入力ファイルの種類を選択します。File Watcher は、この種類のファイルのみを分析および処理の対象と見なします。ファイルの種類は、ファイルの種類とファイル拡張子の関連付けに基づいて認識されます。

   既定では、このフィールドには選択した定義済みのテンプレートに従ってファイルの種類が表示されます。

2. ファイル監視が適用されるスコープを選択します。

   これらのファイルを変更すると、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスの状態に応じて、直ちに、または保存またはフレームの非アクティブ化時にファイル監視が起動されます。

   リストから定義済みスコープの 1 つを選択します。プロジェクトレベルのファイル監視の場合は、 をクリックして、表示されるスコープダイアログでカスタムスコープを設定することもできます。

   • すべての場所 : 下記のすべての範囲

   • プロジェクトファイル : プロジェクトコンテンツルート内のすべてのファイル ( ディレクトリ構造を参照)。

   • プロジェクトのプロダクション用ファイル : テストソースを除くプロジェクトコンテンツルート内のすべてのファイル。

   • プロジェクトテストファイル : プロジェクト内のすべてのファイルがテストソースのルートになります。

   • スクラッチとコンソール : プロジェクトツールウィンドウにあるスクラッチとコンソールディレクトリからのすべてのファイル。

   • 開いているファイル : 現在エディターで開かれているすべてのファイル。

   • 現在のファイル : アクティブなエディタータブで開かれたファイル

   VCS スコープ : これらのスコープは、プロジェクトがバージョン管理されている場合にのみ使用できます。

   • すべての変更ファイル : すべての変更されたファイル、つまりすべての既存の変更リストに関連付けられたすべてのファイル。

   • デフォルト変更リスト : 変更リスト Default に関連付けられているすべてのファイル。

   または、 をクリックし、開いたスコープダイアログでカスタムスコープを構成します。

3. オプション : File Watcher が依存関係を処理する方法を指定します。ルートファイルとは、指定されたスコープ内の他のファイルに (たとえば、import 経由で) 含まれていないファイルです。

   • ファイルウォッチャーをルートファイルに対してのみ実行するには、ルートファイルのみを追跡するチェックボックスを選択します。

   • このチェックボックスをオフにすると、呼び出されたファイルと、指定されたスコープ内にこのファイルが再帰的に含まれるすべてのファイルに対して File Watcher が実行されます。

   スコープ設定はルートファイルのみを追跡するチェックボックスの設定よりも優先されることに注意してください。依存関係が指定されたスコープの外にある場合、ファイルウォッチャーはそれに適用されません。

1. プログラムフィールドに、ツールの実行可能ファイルへのパス（.exe、.cmd、.bat、または特定のツールに応じてその他）を指定します。

2. 引数フィールドで、ツールに渡す引数を定義します。

   引数は通常、実際のファイル名に置き換えられる $FileName$ や $FileNameWithoutExtension$ などのマクロを使用して指定されます。

   マクロを手動で入力するか、 をクリックして、開いたマクロダイアログのリストから関連するパターンを選択します。

3. リフレッシュする出力パスフィールドで、ツールがその出力を保管するファイル（結果のソースコード、ソースマップ、依存関係）を指定します。これらの設定に基づいて、PhpStorm はコンパイルによって生成されたファイルを認識します。

   通常、出力パスはマクロを使用して指定されます。手動で入力するか、 をクリックして、開いたダイアログのリストから関連するものを選択できます。

   複数のマクロを指定するには、区切り文字としてコロン : を使用します (例: $FileNameWithoutExtension$.css:$FileNameWithoutExtension$.css.map)。

4. を展開します

   作業ディレクトリと環境変数の隠しエリア。

5. 環境変数を定義します。例: 構成しているツールの開始に必要なツールの PATH 変数を指定しますが、そのツールへのパスで参照されていません。ほとんどの場合、Node.js または ruby.exe です。このような状況は、Node パッケージマネージャー (npm) または gem manager によるインストールではなく、カスタムの手動インストールが原因である可能性があります。

6. 作業ディレクトリフィールドで、ツールを適用するディレクトリを指定します。

   ツールは常にファイルのコンテキストで呼び出されるため、デフォルトの作業ディレクトリは現在のファイルのディレクトリです。デフォルトの作業ディレクトリは、$FileDir$ マクロを使用してすべての定義済みテンプレートで指定されます。カスタム作業ディレクトリを指定するには、そのパスをフィールドに入力するか、 をクリックしてパスの選択ダイアログでディレクトリを選択するか、 をクリックしてマクロダイアログのリストから目的のマクロを選択します。

1. ファイルウォッチャーを呼び出すイベントを指定します。

   • ソースコードに変更が加えられたらすぐにファイルウォッチャーを呼び出すには、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスを選択します。

     チェックボックスをオフにすると、保存時 ( ファイル | すべて保存 ) または PhpStorm からフォーカスを移動したとき (フレームの非アクティブ化時) に File Watcher が起動します。

   • デフォルトでは、File Watcher は、たとえばブランチをチェックアウトしたときにバージョンコントロールシステムから受信した更新など、保存された変更があると起動します。このような変更を無視し、PhpStorm でコードを更新したときにのみ File Watcher を呼び出すには、外部の変更でウォッチャーをトリガーするチェックボックスをオフにします。

2. File Watcher が PhpStorm 構文パーサーと対話するかどうかを指定します。

   • 構文エラーに関係なく監視をトリガーするチェックボックスをオンにすると、File Watcher はファイルの構文上の正確さに関係なく起動します。ファイルウォッチャーは、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスの状態に応じて、更新、保存、フレームの非アクティブ化時に開始されます。

   • 構文エラーに関係なく監視をトリガーするチェックボックスをオフにすると、File Watcher は構文上無効なファイル内のすべてのトリガを無視し、エラーのないファイルでのみ起動します。

3. stdout から出力ファイルを作成するチェックボックスを使用して、出力ファイルの生成方法を指定します。

   • チェックボックスが選択されると、PhpStorm はネイティブツールの出力 standard output stream (stdout) を読み込み、そこから結果ファイルを生成します。

   • チェックボックスをオフにすると、ツールはその出力をリフレッシュする出力パスフィールドで指定されたファイルに直接書き込みます。

4. コンソールの表示リストで、File Watcher がいつコンソールを開くかを選択します。

   • 常時 : このオプションを使用すると、ツールの実行が完了した後にコンソールが常に開きます。

   • エラー時 : このオプションを使用すると、Exit code が 0 と異なる場合にのみツール実行後にコンソールが開きます。

   • なし : コンソールをまったく開かないようにするには、このオプションを選択します。

• ファイルウォッチャーを有効または無効にするには、設定ダイアログ（Ctrl+Alt+S）を開き、ツール | File Watchers に移動して、その横にあるチェックボックスをオンまたはオフにします。

  ファイルウォッチャーが有効になっている場合、選択したスコープ内の選択したタイプのファイルが変更または保存されるとすぐに自動的に開始されます。詳細オプションの構成を参照してください。

  ファイル監視の実行中にエラーが発生した場合、ファイル監視は自動的に無効になります。ステータスを復元するには、ファイル監視を手動で有効にします。

保存時にファイルウォッチャーを自動的に実行する

変更が保存されたときに、変更されたファイルでファイルウォッチャーを自動的に実行するように IDE を構成できます。

1. Ctrl+Alt+S を押して設定を開き、ツール | 保存時のアクションを選択します。

2. File Watcher オプションを有効にして、変更を適用します。