JetBrains Rider 2020.1ヘルプ

ファイル監視

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

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

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

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

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

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

    Enable File Watcher pane

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

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

始める前に

ファイル監視バンドルプラグインがプラグインのページで有効になっていることを確認してください。詳細については、プラグインの管理を参照してください。

ファイル監視の作成

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    VCSスコープ : これらのスコープは、プロジェクトがバージョン管理下にある場合にのみ使用可能です。

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

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

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

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

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

    または、the Browse button をクリックして、表示されるスコープダイアログでカスタムスコープを設定します。

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

  3. オプション : ファイル監視プログラムが依存関係をどのように処理するかを指定します。ルートファイルとは、指定された範囲内の他のファイルに含まれていないファイルです(たとえば importを介して)。

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

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

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

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

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

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

    プロジェクト内にインストールされているツール(Prettier(英語)など)のグローバルファイル監視を構成する場合は、マクロを使用してそのファイルへのパスを指定する必要があります。パスで使用可能なマクロの1つを使用するには、マクロの挿入ボタンを押します。例:パス $ProjectFileDir$/node_modules/.bin/prettierを使用すると、ファイル監視はプロジェクトの node_module フォルダーにインストールされているprettierを使用します。

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

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

    手動でマクロを入力するか、またはマクロの挿入をクリックして、表示されるマクロダイアログのリストから該当するパターンを選択します。

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

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

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

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

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

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

詳細オプションの構成

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

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

    • ソースコードが変更されるとすぐにファイル監視を呼び出すには、編集したファイルを自動保存してウォッチャーをトリガーするチェックボックスをオンにします。
      チェックボックスをオフにすると、ファイルウォッチャーは保存(ファイル | すべて保存)またはJetBrains Rider(フレーム非アクティブ化時)からフォーカスを移動すると開始します。

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

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

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

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

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

    • チェックボックスが選択されると、JetBrains Riderはネイティブツールの出力 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 を使用してウォッチャーをリストから削除するか、編集して同じ名前の新しいグローバルウォッチャーを作成します。

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

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

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

最終更新日: 2020年7月2日

関連ページ:

プラグイン

macOSのこのページで設定可能な設定は、ディレクトリベースの設定のメカニズムを使用して保存されます。このページを使用してプラグインを管理します。プラグインリポジトリの閲覧、プラグインのインストール、削除、有効化、無効化、および更新を行います。主なコントロール:マーケットプレースこのタブを使用して、...

プラグインを管理する

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

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

JetBrains Riderで認識されないファイルタイプ(社内で開発された独自のファイルタイプなど)を使用している場合や、サポートされていない言語でコーディングする必要がある場合は、カスタムファイルタイプを作成できます。キーワード、コメント、数字などの強調表示スキームを定義することによって、IDE...

バージョン管理を有効にする

JetBrains Riderは2つのレベルでバージョン管理統合をサポートします。IDEレベルでは、VCS統合はデフォルトで有効になっている一連のバンドルプラグインを通じて提供されます。ソリューションレベルでは、ソリューションフォルダーを1つまたは複数のバージョン管理システムに関連付けることにより、...

スコープとファイルの色

Ascopeis a group of files and folders in a solution. You can use scopes tovisually distinguishsolution items in different IDE views and to limit the r...

Vagrant: 再現可能な開発環境の使用

JetBrains RiderはVagrantと統合されており、Vagrantfile構成ファイルで定義された再現可能な開発環境を作成できます。IDEを離れずに、仮想ボックスの作成や削除、Vagrantボックスの初期化、Vagrant設定ファイルからの設定の読み取りによるリモートインタープリターの設...