GoLand 2020.3 ヘルプ

ファイル監視

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

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

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

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

使用可能なテンプレートの 1 つを使用するか、ファイル監視を最初から構成できます。構成されたファイル監視は、プロジェクト設定または IDE 設定に保存して、さまざまなプロジェクトで使用できます。次のイメージは、ファイル監視の定義済みテンプレートを示しています。定義済みテンプレートのリストは変更できません。

Templates for file watchers

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

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

ファイル監視の作成

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

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

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

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

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

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

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

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

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

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

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

    • プロジェクトファイル : プロジェクト内のすべてのファイル

    • スクラッチとコンソール : ファイルツールウィンドウ(表示 | ツールウィンドウ | ファイル)のすべてのスクラッチとコンソール。

    • 最近表示したファイル : エディターで最近表示されたすべてのファイル。

    • 最近変更したファイル : エディターで最近変更されたすべてのファイル。

    • 新規モジュール : 現在のモジュール内のすべてのファイル。

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

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

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

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

    詳細はスコープを参照してください。

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

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

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

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

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

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

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

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

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

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

  5. 環境変数を定義します。例:構成するツールの開始に必要なツールの PATH 変数を指定しますが、そのパスで参照されていません。

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

詳細オプションの構成

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • ウォッチャーの編集ダイアログの出力フィルターフィールドで、照合する出力の形式を記述します。そのためにマクロ $FILE_PATH$$LINE$$MESSAGE$ を使用します。 \ では、中括弧やドットなどの特別な記号を使用しないようにする必要があります。 $MESSAGE$ マクロと一致するテキストがエディターに表示されます。

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

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

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

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

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

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

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

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

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

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

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

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

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

GoLand は多数の同一のファイル監視タスクを実行します

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

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

関連ページ:

CSS の最小化

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

Sass、Less、SCSS

SASS および LESS 機能を使用するには、SASS および LESS プラグインをインストールします。GoLand は、Sass、Less、SCSSコードをCSSに変換するコンパイラーと統合します。GoLand でコンパイラーを使用するには、関連する事前定義済みテンプレートに基づいて、ファイル...

プラグイン

GoLand のユーザーインターフェースはデフォルトでは英語です。日本語化する場合は、日本語言語パックのインストールを参照してください。プラグインは以下に示すように GoLand のコア機能を拡張します。バージョン管理システム、アプリケーションサーバー、およびその他のツールとの統合を提供する、さまざ...

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

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

色とフォント

開発者として、エディターのソースコード、検索結果、デバッガー情報、コンソールの入出力など、多くのテキストリソースを使用します。色とフォントスタイルは、このテキストのフォーマットに使用され、一目で理解しやすくなります。GoLand は、好適な色とフォントを定義するカラースキームを使用しています。事前定...

キーボードショートカット

GoLand 標準のキーボードショートカット PDF は、公式ショートカット一覧 PDF 日本語版から入手できます。ローカルに保存しておいて活用しましょう。GoLand には定義済みのキーマップがいくつか含まれており、頻繁に使用するショートカットをカスタマイズできます。キーマップ構成を表示するには、...