RubyMine 2026.1 Help

RBS

RubyMine は RBS 言語をサポートしており、Ruby プログラムで使用される型を記述するのに利用できます。 RubyMine は .rbs ファイルを認識し、次のコーディング支援を提供します：

RBS は、すぐに使用できる標準ライブラリ用の一連の組み込み型シグネチャーを提供します。 プロジェクトで RBS を使用すると、RubyMine はそのソースを外部ライブラリに表示します。

RubyMine は rbs_collection.lock.yaml ファイルでも動作します。 このシナリオでは、RubyMine は、どの型シグネチャーがロードされ、コードインサイトに使用されるかを決定します。 詳細については、 ドキュメント(英語)を参照してください。

RBS 型の署名

RubyMine は RBS 型シグネチャーをサポートし、Ruby 要素の型を決定するために使用しています。 これにより、Ruby でコードを開発する際に、より良いコードインサイトを体験することができます。

プロジェクトに RBS ファイルがある場合、RubyMine は以下を提供します：

  • メソッド補完の改善

    RubyMine は、コード補完を呼び出すときに、リストの先頭に適切なクラスのメソッドを表示します。

    RBS によるメソッド名の補完

  • Ruby 補完時の RBS からの追加宣言

    RubyMine は、Ruby ファイルに存在しない RBS からの追加の宣言を認識します。 これは、これらの宣言を補完時にも存在させることができるため、リフレクションを頻繁に使用するプロジェクトにとって特に有益です。 この機能は、クラス、モジュール、定数、メソッド、変数で利用できます。

    RBS からの追加の宣言

  • 改善されたナビゲーションアクション

    「Go to declaration」アクションを呼び出すと、RubyMine は、選択する宣言のリストを提供する代わりに、正確な宣言に移動します。

  • 対応する宣言の使用箇所を検索

    RBS 型では、RubyMine は Ruby 要素の正しい宣言を見つけることができます。 'リファクタリング' アクションを呼び出すと、RubyMine は、選択可能な宣言のリストを提供する代わりに、対応する宣言の使用箇所を即座に検出します。

    RBS で使用箇所を検索する

  • 一貫した名前変更リファクタリング

    RubyMine が RBS を利用する場合、すべての潜在的なオプションを表示するのではなく、関連するエンティティの名前を変更することのみを提案します。

    RBS でリファクタリングの名前を変更

型情報を表示する

  • RBS シグネチャーが提供されると、RubyMine はそれらを使用して Ruby 要素の型を決定します。 要素型を表示するには、目的の Ruby 要素にキャレットを置き、メインメニューで 表示 | 型情報 Ctrl+Shift+P に移動します。

    型情報の表示

パラメーター情報を表示する

RubyMine は、RBS シグネチャーを使用して、 パラメーター情報ポップアップにメソッドパラメーターの型を表示します。 デフォルトでは、エディターで角括弧を入力するか、候補リストからメソッドを選択すると、RubyMine によってポップアップが自動的に表示されます。

  • パラメーター情報。 ポップアップを明示的に呼び出すには、メインメニューの 表示 | パラメーター情報 Ctrl+P に移動します。

    パラメーター情報の表示

型が一致することを確認する

  • RubyMine は、RBS ファイルの型と一致しない型を使用しようとすると警告します。

    互換性のないパラメーター型

    これらの警告は、 不一致型 インスペクションを使用して管理できます。 インスペクションは、次の目的で使用できます。

    • 一定の割り当て

    • インスタンス変数とクラス変数への割り当て (シングルトンクラス / メソッドにインスタンス変数を含める)

    • メソッドとブロックでのパラメーター割り当て

    • メソッドとブロックの戻り値

    • メソッドと yield 呼び出しの引数

クイックドキュメントを見る

クイックドキュメントを使用して、使用中の RBS 署名に関する情報を取得できます。

  1. エディターで必要なシンボルの上にマウスを置きます。

  2. シンボルにキャレットを置き、 Ctrl+Q を押すか、メインメニューから 表示 | クイックドキュメント を選択します。

    Ctrl+Q をもう一度押して、 ドキュメント ツールウィンドウでこのドキュメントを開きます。

  3. ポップアップで 「オプションメニューを表示」アイコン をクリックしてフォントサイズを変更したり、クイックドキュメントツールバーを表示したり、ソースコードに移動したりできます。

RBS コレクション

RubyMine には、独自の型シグネチャーを含まない gem 用のコミュニティ管理の RBS ファイルのコレクションである RBS コレクションとの統合が組み込まれています。 この統合により、RBS を明示的に使用しない場合でも、プロジェクトの依存関係の型署名のメリットを享受できます。 RubyMine は、これらの型シグネチャーをバックグラウンドでシームレスにダウンロードし、プロジェクト内のすべての gem の型サポートとコードインサイトを向上させます。

ダウンロードした型署名は、 rbs_collection [bundled] の 外部ライブラリ ノードにあります。

この機能はデフォルトで有効になっており、プロジェクトインタープリターに RBS gem バージョン 3.2 以降がインストールされている必要があります。 Ruby 3.4 には互換バージョンが付属していますが、インタープリターにそれ以前の RBS バージョンが搭載されている場合、または gem が全くインストールされていない場合は、RubyMine に最新バージョンのインストールを促す通知が表示されます。

通知から RBS をインストールする

RBS ファイルを作成する

  1. プロジェクトビュー Alt+1 で、新しい RBS ファイルを作成するディレクトリを選択します。

  2. Alt+Insert を押して、ポップアップから RBS ファイル / クラス を選択します。

    新しい RBS ファイルを作成する

    別のオプションとして、メインメニューから ファイル | 新規 | RBS ファイル / クラス を選択します。

  3. ファイル名を指定して、 Enter を押します。

RBS プロトタイプを生成する

RubyMine は、Ruby コードから 単純なシグネチャープロトタイプを生成するためのツールを提供します。 これらのプロトタイプは、プロジェクトに新しい RBS 型を追加し始める方法を理解するのに役立つ場合があります。

  1. 型シグネチャーを生成する Ruby ファイルを開きます。

  2. メインメニューで、 コード | 生成する Alt+Insert に移動します。

  3. 生成する ポップアップで 型シグネチャー を選択します。

    RBS プロトタイプを生成する

    RubyMine は、Ruby ファイルと同じ名前の新しい RBS ファイルを生成します。 結果のプロトタイプに含まれるすべての型は、 untyped として指定されます。 型シグネチャーを書き込むためのテンプレートとして使用できます。

クイックフィックスを使用して不足している型シグネチャーを追加する

Missing Type Signature インスペクションのクイックフィックスを使用して、欠落している型シグネチャーをいつでも追加できます。 RubyMine は、既存の RBS ファイルに移動するか、必要に応じて新しい RBS ファイルを作成し、それぞれのシグネチャーテンプレートを生成します。

  1. 型シグネチャーがない Ruby シンボルにキャレットを置きます。

  2. Alt+Enter を押すか、問題のある行の インテンションアクションボタン アイコンをクリックします。

    欠落している型シグネチャーを追加する

  3. メニューから 型シグネチャーを追加 フィックスを選択します。

  4. 開いた RBS ファイルで、型シグネチャーを更新します。

型シグネチャーを編集する

RubyMine を使用すると、専用のインテンションアクションまたは型不一致インスペクションで使用できるクイックフィックスを利用して、Ruby ファイルの型シグネチャーを編集できます。

  1. 編集する型の署名である Ruby シンボルにキャレットを置きます。

  2. Alt+Enter を押して、メニューから 型シグネチャーの編集 を選択します。

    インテンションを使用して型シグネチャーを編集する
    クイックフィックスを使用して型シグネチャーを編集する

  3. 開いた RBS ファイルで、型シグネチャーを更新します。

RBS ファイルの構造を表示する

構造 ツールウィンドウ Alt+7 を使用して、RBS ファイルの高レベルの構造を調べることができます。

構造ツールウィンドウ

Ruby ファイルと RBS ファイル間を移動する

RubyMine を使用すると、Ruby 宣言からその型シグネチャーに、またはその逆に移動できます。 ナビゲーション機能は次の目的で利用できます。

  • 属性 (現在、RBS から Ruby に移動する場合にのみ機能します)

  • クラス、モジュール、定数

  • クラス変数とインスタンス変数

  • グローバル変数

  • メソッド (singleton を含む)

型署名に移動する

  • Ruby 宣言を選択し、 移動 | 型シグネチャー に移動して、その型シグネチャーに移動します。

    Navigating between a Ruby declaration and its type signature

関連する Ruby 宣言に移動する

  • 型シグネチャーを選択し、 移動 | 関連する宣言 に移動して、関連する Ruby 宣言に移動します。

    Navigating between an RBS signature and an associated Ruby declaration

Navigate with intention actions

  1. キャレットを必要な要素に配置し、 Alt+Enter を押します。

  2. リストから必要な型署名または関連する宣言に移動するアクションを選択します。 Enter を押して、インテンションアクションを適用します。

    Navigate with intention actions

関連する Ruby または RBS 要素に移動する

  1. 必要な要素にキャレットを置き、メインメニューの 移動 | 関連シンボル Ctrl+Alt+Home に移動します。

  2. 必要に応じて、ポップアップから目的のターゲットを選択します。

    Navigate to a related Ruby element

Steep を使用して Ruby の型を確認する

RubyMine は、 Steep コマンドを Run anything で実行することをサポートします。 Steep を使用する前に、必ず steep gem を Gemfile に追加してください。

gem 'steep'

Steep をインストールした後、プロジェクトの Steepfile を生成する必要があります。

Steepfile を生成して構成する

  1. Ctrl を 2 回押します。

  2. 検索フィールドに steep init と入力し始めます。 提案のリストからコマンドを選択し、 Enter を押します。 RubyMine は、プロジェクトの Steepfile を生成します。

  3. 生成された Steepfile を開いて編集します。 例：

    target :lib do check "lib" signature "sig" library "set", "pathname" end

型チェックを実行する

  1. Ctrl を 2 回押します。

  2. 検索フィールドに steep check と入力し始めます。 提案のリストからコマンドを選択し、 Enter を押します。

    RubyMine は、コマンド出力を 実行 ツールウィンドウに表示します。

    実行ツールウィンドウのコマンド出力

コードスタイルの設定を構成する

RubyMine は、Ruby と RBS の両方に同じコードスタイル設定を適用します。 RBS の コードスタイルをカスタマイズするには:

  1. 設定 ダイアログ（Ctrl+Alt+S ）で エディター | コードスタイル | Ruby に移動します。

  2. 必要なコードスタイル設定を構成します。

構文ハイライトを構成する

RubyMine は、Ruby カラースキームを使用して、RBS ファイルの構文をハイライトします。

好みや習慣に応じて、RBS 対応の構文のハイライトを構成できます。

  1. 設定 ダイアログ（Ctrl+Alt+S ）で エディター | カラースキームの切り替え | Ruby に移動します。

  2. カラースキームを選択し、デフォルトから継承されたハイライト設定を受け入れるか、 色とフォント の説明に従ってカスタマイズできます。

2026 年 6 月 2 日
Chef サポートSorbet