IntelliJ IDEA 2020.2ヘルプ

ファイル監視

ファイル監視は、IntelliJ IDEAツールであり、IDEでファイルを変更または保存するときに、コンパイラー、フォーマッター、またはlinterなどのコマンドラインツールを自動的に実行できます。

ファイルウォッチャーには、2つの専用コードインスペクションがあります。

  • ファイル監視使用可能 インスペクションは、あらかじめ定義されたファイル監視が適用されるすべてのファイルで実行されます。プロジェクトに関連するファイル監視が設定されていない場合、IntelliJ IDEAはファイルウォッチャーを追加することを提案します。

  • ファイル監視問題 インスペクションは、実行中のファイル監視によって呼び出され、それに特有のエラーを強調表示します。

利用可能なテンプレートの1つを使用するか、ファイル監視を最初から構成することができます。設定したファイル監視は、プロジェクト設定またはIDE設定に保存して、さまざまなプロジェクトで使用できます。

  • 事前定義されたファイル監視が適用可能なファイルを開くと、IntelliJ IDEAはそれをアクティブにするよう提案するペインを表示します。

    Enable File Watcher pane

    はいをクリックして、デフォルトの構成でファイル監視をアクティブにします。

  • いいえをクリックすると、IntelliJ IDEAは提案されたファイル監視が抑制されていると見なします。以下のファイル監視の作成の説明に従って、手動で作成して有効にすることができます。

特定のツールのファイルウォッチャーの詳細については、対応するページを参照してください。

IntelliJ IDEAでこれらのツールの一部を使用するには、JetBrainsリポジトリからプラグインをインストールするに従って、設定/環境設定 | プラグインページにプラグインをインストールする必要があることに注意してください。

始める前に

JetBrainsリポジトリからプラグインをインストールする説明に従って、設定/環境設定 | プラグインページでファイル監視プラグインをインストールして有効にします。

ファイル監視の作成

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

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

  3. 名前」フィールドに、ファイル監視の名前を入力します。デフォルトでは、IntelliJ IDEAは選択された定義済みテンプレートの名前を提案します。

入力ファイルの予想されるタイプと場所の構成

監視するファイル領域のコントロールを使用して、ファイルウォッチャーを適用するファイルの範囲を定義します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    詳細はスコープとファイルの色を参照してください。

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

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

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

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

外部ツールとの相互作用の構成

変更時に実行するツール領域で、使用するツール、ツールに渡す引数、予想される出力ファイルの種類などを指定します。

  1. プログラムフィールドで、ツールの実行可能ファイルへのパスを指定します(特定のツールに応じて、.exe.cmd.batなど)。

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

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

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

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

    リフレッシュする出力パスフィールドの値を変更しても、ツールはその出力を別の場所に保存しません。それでもそれを行う必要がある場合は、引数フィールドに希望のカスタム出力位置を指定します。コロンとしてコロンを使用して出力パスを区切り文字として入力し、マクロを使用します。

    出力パスは通常、マクロを使用して指定されます。パスを手動で入力するか、the Insert Macros icon をクリックして、リストから関連するパターンを選択します。

  4. 作業ディレクトリと環境変数隠し領域を展開します。

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

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

詳細オプションの構成

拡張オプション領域では、ファイル監視のデフォルト動作をカスタマイズします。

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

    • ソースコードに変更が加えられた直後にファイル監視を呼び出すには、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスを選択します。
      チェックボックスがオフの場合、保存時(ファイル | すべて保存)、またはIntelliJ IDEAからフォーカスを移動したときに(フレームの非アクティブ化時に)ファイル監視が起動します。

    • デフォルトでは、ファイル監視は、たとえばブランチをチェックアウトしたときにバージョン管理システムから受け取った更新を含め、保存された変更が発生すると起動します。このような変更を無視して、IntelliJ IDEAでコードを更新するときにのみファイル監視を呼び出すには、外部の変更でウォッチャーをトリガーするチェックボックスをオフにします。

  2. ファイルウォッチャーがIntelliJ IDEA構文解析プログラムと対話するかどうかを指定します。

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

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

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

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

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

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

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

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

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

ファイル監視によって報告された情報をエディターに表示する

ファイル監視で設定されたツールがファイルに関するエラーや警告をファイルや特定の行へのリンクで報告した場合は、この情報をエディターで直接見ることができます。

  • 環境設定/設定 | エディター | インスペクションでは、インスペクション ファイル監視問題を有効にします。

  • ウォッチャーの編集ダイアログの出力フィルターフィールドに、一致させたい出力のフォーマットを記述します。そのためにはマクロ $FILE_PATH$ , $LINE$$MESSAGE$ を使ってください。 \では中括弧やドットのような特別な記号を使わないでください。 $MESSAGE$ マクロと一致したテキストがエディターに表示されます。

サンプル

このツールは、次の形式でエラーを報告します。

ERROR: /Users/Alice/WebstormProjects/angular-app/src/main.ts[6, 27]: " should be '
エディターで強調表示されたエラーを表示するには、次の正規表現を出力フィルタとして使用します。
ERROR: $FILE_PATH$\[$LINE$, $COLUMN$\]: $MESSAGE$

ファイル監視の保存、有効化および無効化

新しいファイル監視を保存したら、現在のプロジェクト(レベルリストからプロジェクトを選択)でのみ使用可能にするか、すべてのプロジェクト(グローバルを選択)で使用可能にするかを決定できます。

Global File Watcher
  • ファイル監視を有効または無効にするには、設定/環境設定ダイアログ Ctrl+Alt+Sを開き、ツール | ファイル監視に移動して、その横のチェックボックスを選択または選択解除します。

    ファイルウォッチャーを有効にすると、選択した種類のファイルが選択された範囲内で変更または保存されるとすぐに自動的に開始されます(詳細オプションの構成を参照)。

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

新しいプロジェクトでグローバルファイルウォッチャーを有効にする

グローバル File Watcherは、将来作成するすべての新しいプロジェクトで自動的に有効にできます。

  • 新規プロジェクトの設定ダイアログ(ファイル | 新規プロジェクトの設定 | 新規プロジェクトの設定)を開き、ツール | ファイル監視に移動して、必要なファイル監視の横にあるチェックボックスを選択します。

  • または、ようこそ画面で、構成リストから設定を選択します。開いたダイアログで、関連するファイル監視の横にあるチェックボックスを選択します。

ファイル監視のトラブルシューティング

環境設定/設定 | ツール | ファイル監視のリストのファイルウォッチャーの横に赤いエラーメッセージが表示されることがあります。

File Watcher Error Message

起こりうるエラーのリストを以下に示します。

報告された問題問題説明回避策
Unknown Scope errorファイルウォッチャーは、このプロジェクトで定義されていないスコープを使用します。ウォッチャーをダブルクリックして、使用可能なスコープを選択するか、新しいスコープを作成します。
Not found errorこのプロジェクトは、削除されたグローバルファイル監視を使用します。除去ボタン Remove を使用してウォッチャーをリストから削除するか、編集して同じ名前の新しいグローバルウォッチャーを作成します。

IntelliJ IDEAは多数の同一のファイル監視タスクを実行する

たとえば、VCSから一括更新した後、IntelliJ IDEAは保存されたファイルごとに個別のファイル監視タスクを実行します。

引数フィールドにファイル固有のマクロ( &FileNameWithoutExtension&など)を追加します。外部ツールとの相互作用の構成を参照してください。
最終更新日: 2020年8月19日

関連ページ:

JavaScript の最小化

最小化または圧縮とは、ソースコードの機能を変更せずに、スペース、改行、コメントなどのすべての不要な文字を削除することを意味します。開発中およびデバッグ中、これらの文字はコードを読みやすくします。本番段階では、転送されるコードのサイズが増加するだけです。ほとんどの場合、圧縮は、webpackなどのビル...

CSS の最小化

最小化または圧縮とは、ソースコードの機能を変更せずに、スペース、改行、コメントなどのすべての不要な文字を削除することを意味します。開発中およびデバッグ中、これらの文字はコードを読みやすくします。本番段階では、転送されるコードのサイズが増加するだけです。ほとんどの場合、圧縮はwebpackなどのツール...

Sass、Less、およびSCSS

IntelliJ IDEAは、Sass、Less、およびSCSSコードをCSSに変換するコンパイラーと統合します。IntelliJ IDEAでコンパイラーを使用するには、関連する事前定義済みテンプレートに基づいて、ファイル監視としてコンパイラーを構成する必要があります。また、コンパイラをコマンドライ...

CoffeeScript

IntelliJ IDEAでは、JavaScriptにコンパイルするCoffeeScriptを使用できます。IntelliJ IDEAは*.coffeeファイルを認識し、でマークします。CoffeeScriptコードに直接ブレークポイントを設定することができ、IntelliJ IDEAはコンパイル中...

プラグインを管理する

プラグインはIntelliJ IDEAのコア機能を拡張します。彼ら:バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざまな言語とフレームワークのコーディング支援サポートを追加する、ショートカットヒント、ライブプレビュー、ファイルウォッチャーなどで生産性を...

ファイルタイプの関連付けを設定する

IntelliJ IDEAはデフォルトのファイルタイプのセットを認識します。そのようなファイルは、対応する言語の構文に従って解析および強調表示されます。IntelliJ IDEAが認識できないファイルタイプで作業している場合(たとえば、それが独自開発のファイルタイプである場合)、カスタムファイルタイ...