JetBrains Rider 2024.1 ヘルプ

Flow

Flow(英語) は、JavaScript に型アノテーションをもたらす静的型チェッカーです。JetBrains Rider は Flow 構造を認識し、すべてのオペレーティングシステムでそれらの構文をハイライトします。

始める前に

Node.js をダウンロードしてインストールします。

Flow のインストールと構成

  • 埋め込まれたターミナルAlt+F12)で、次のいずれかのコマンドを入力します。

    • npm install --global flow-bin を使用して Flow をグローバルにインストールします。

    • 開発依存として Flow をインストールするための npm install --save-dev flow-bin

Flow オフィシャル Web サイト(英語)の詳細を参照してください。

JetBrains Rider に Flow 構造を認識させ、正しい構文ハイライトを提供し、エラーを適切に報告し、誤検出エラーハイライトを回避し、プロジェクトの JavaScript 言語レベルを Flow に変更し、.flowconfig 構成ファイルをプロジェクトに追加し、上部に // @flow コメントでチェックされています。

プロジェクトの言語レベルを Flow に変更する

  1. 設定 / 環境設定ダイアログ(Ctrl+Alt+S)で、言語 & フレームワーク | JavaScript に移動します。JavaScript ページが開きます。

  2. JavaScript 言語バージョンリストから Flow を選択します。

  3. Flow パッケージまたは実行可能ファイルフィールドで、node_modules\flow-bin パッケージまたは Flow バイナリ実行可能ファイルへのパスを指定します。node_modules\.bin\flow を使用するには、Node.js へのパスが PATH 環境変数に追加されていることを確認してください。

  4. Flow サーバーを使用する : エリアで、次のチェックボックスをオンまたはオフにして、コーディング支援の基礎を指定します。

    • 型チェック : このチェックボックスを選択すると、Flow サーバーから受信したデータに基づいて構文とエラーのハイライトが行われます。このチェックボックスをオフにすると、基本的な内部 JetBrains Rider ハイライトのみが使用可能になります。

    • ナビゲーション、コード補完、および型のヒント : このチェックボックスを選択すると、参照解決とコード補完の候補リストには、Flow との統合から取得された候補と JetBrains Rider によって計算された候補の両方が含まれます。このチェックボックスをオフにすると、参照は JetBrains Rider 計算によってのみ解決されます。

    チェックボックスは、Flow 実行ファイルへのパスが指定されている場合にのみ使用できます。

  5. Flow は他の変更されたファイルがすべて保存された後にのみ現在のファイルをチェックするため、Flow が継続的に適用されるようにするには、すべての変更されたファイルを自動的に保存するチェックボックスを選択したままにしておきます。

Flow を有効にする

  1. .flowconfig を追加するには、埋め込みターミナルAlt+F12)を開いて次を入力します。

    flow init

    .flowconfig を特定のフォルダーに追加するには、次を入力します。

    cd <path to the folder to check>

    flow init

  2. ファイルで Flow を有効にするには、ファイルの上部に // @flow コメントを追加します。単に flow と入力して Tab を押すと、JetBrains Rider が // @flow に展開します。

    まだ .flowconfig を持っていない場合、JetBrains Rider は、現在のフォルダーに構成ファイルを追加するように促すツールチップを表示します。

    Tooltip: Add .flowconfig to the current folder

    現在のフォルダーとプロジェクトルートを選択するには、その他のアクションをクリックするか、Alt+Enter を押します。

    Tooltip: More actions

監視エラー

JetBrains Rider を使用すると、Flow によって検出されたエラーを問題ツールウィンドウに表示できます。ツールウィンドウを開くには、メインメニューから表示 | ツールウィンドウ | 問題を選択するか、エディターの右隅にあるウィジェットをクリックします。

Inspection widget

ツールウィンドウは 2 つのペインで構成されています。

  • エラーペインには、アクティブなエディタータブで開かれているファイルで検出されたすべての不一致のリストが表示されます。上部にファイルへのフルパスが表示されます。

    Errors pane

    エラーに関する詳細情報を入手するには、その説明のコンテキストメニューからエラーの詳細を表示を選択します。

    Errors pane: details shown
  • プロジェクトエラーペインには、現在のプロジェクトのすべてのファイルで検出されたすべての不一致のリストが表示されます。エラーメッセージは、それらが検出されたファイルごとにグループ化されています。

    Project Errors pane