JetBrains Rider 2024.1 ヘルプ

言語およびフレームワーク: YAML

JetBrains Rider を使用すると、YAML ファイル(.yml.yaml)を操作でき、次の機能がサポートされます。

  • 構文のハイライト

    カラー設定は、設定 / 環境設定ダイアログ (Ctrl+Alt+S) のエディター | カラースキームの切り替え | YAML ページで変更できます。

  • コードのフォーマット

    YAML に関連するコードスタイル設定には、設定 / 環境設定ダイアログ (Ctrl+Alt+S) のエディター | コードスタイル | YAML ページでアクセスできます。

  • Inspections(英語)

    JetBrains Rider は、重複したキー、YAML ドキュメント内の未使用のアンカーなどを検出します。

  • コード補完

    例: コード補完を JSON スキーマを持つ YAML 文書に使用するか、アンカーエイリアスを完成させることができます。

  • ナビゲーションと検索

    たとえば、アンカーとエイリアスの間を移動できます。

  • アンカーの使用箇所の検索

  • 名前の変更リファクタリング (たとえば、アンカーとエイリアスの場合)

エディターで利用可能な YAML 固有の機能をいくつか見てみましょう。

アンカーとエイリアス

JetBrains Rider は、アンカーとエイリアスの使用をサポートしています。YAML ファイルで新しいアンカーを指定すると、エディターはこのアンカーがどのノードでも使用されていないという警告を表示します。

YAML: unused anchor warning

エディターを使用すると、このアンカーのエイリアスを完成させることができます。

YAML: complete alias

アンカーの使用箇所をすばやく見つけるには、アンカー上にキャレットを置き、Ctrl+B を押します。

YAML: navigate to aliases

JetBrains Rider は、アンカーとエイリアスの名前変更リファクタリングをサポートしています。アンカー上にキャレットを置き、Shift+F6 を押します。または、アンカーを右クリックしてリファクタリング | 名前の変更を選択します。

renaming the YAML anchor

構造ツールウィンドウ (Alt+7) を使用して、YAML ファイル内をすばやく移動します。構造ツールウィンドウで再利用されたアンカーの要素を表示または非表示にするには、 View Options use エイリアスサブツリーをクリックします。

YAML structure view

JSON スキーマ

JetBrains Rider は、JSON スキーマを使用する YAML ファイルのコード補完およびインスペクションをサポートします。JetBrains Rider は、(ファイルの場所または構造に基づいて) スキーマを自動的に推測することも、手動で選択することもできます。例: .github/workflows ディレクトリに GitHub アクションワークフローファイルがある場合、JetBrains Rider は、schemastore.org(英語) から自動的にロードされた github-workflow.json スキーマに基づいてオプションを完了することを提案します。

YAML: complete based on schema

設定 / 環境設定ダイアログ (Ctrl+Alt+S) の言語 & フレームワーク | スキーマと DTD | リモート JSON スキーマページを使用して、JSON スキーマのロードを管理できます。

必要に応じて、言語 & フレームワーク | スキーマと DTD | JSON スキーママッピングで必要なスキーマファイルへのパスを指定できます。

ファイルの JSON スキーマを選択する

特定のファイルにカスタムスキーマを指定できます。

  1. ステータスバーのスキーマスイッチャーをクリックします。

    Select schema for a file
  2. 表示されたリストで、提案されたスキーマのいずれかを選択するか、新規スキーママッピング…をクリックします。これにより、ファイルのローカルスキーマまたはリモートスキーマを指定できる JSON スキーママッピング設定が開きます。

スキーマからプロパティを取得する

JetBrains Rider が YAML ファイルのスキーマを検出した場合は、専用のアクションを使用してすべてのプロパティをそのファイルにすばやく挿入できるため、手動で入力する必要がなくなります。

  • スキーマに必須のプロパティが含まれており、これらの特定のプロパティのみを挿入したい場合は、ファイル内の任意の場所で Alt+Enter ( コンテキストアクションの表示 ) を押し、欠落したプロパティの追加を選択します。

  • スキーマで使用可能なすべてのプロパティを挿入する場合は、ファイル内の任意の場所で Alt+Enter ( コンテキストアクションの表示 ) を押し、JSON スキーマからすべてのプロパティを入力しますを選択します。

$schema キーワードを使用する

ファイル自体内でスキーマを参照することもできます。

  1. ファイルの先頭に # $schema: と入力します。

  2. スキーマファイルの名前の入力を開始します。schemastore.org(英語) からロードされたスキーマの名前の補完が得られます。

    ローカルスキーマファイルを使用する場合は、スキーマを使用するファイルに対する相対パスを指定します (例: # $schema: ./my-schema.json)。これにより、インスペクション、補完、プロパティ入力アクションなど、リモートスキーマを使用する場合と同じコーディング支援が可能になります。

    Completion from local schema

キーのコピー

JetBrains Rider は、YAML ファイルで指定された特定のオプションへのフルパスをコピーする機能を提供します。これは 2 つの方法で実行できます。

  • 必要なキーにキャレットを置き、Ctrl+Alt+Shift+C を押します。

  • 必要なキーにカーソルを合わせ、右クリックして参照をコピーを選択します。

YAML: copy references

例: 上のイメージでは、default.server.port がコピーされます。

関連ページ:

配色: IDE テキストのフォントと色

開発者は、エディターのソースコード、検索結果、デバッガー情報、コンソールの入出力など、多くのテキストリソースを操作します。このテキストのフォーマットには色とフォントスタイルが使用されており、一目で理解できるようになります。JetBrains Rider では、IDE テキストで使用される色とフォントを定義する構成可能な配色から選択できます。事前定義された配色を使用するか、あなたの好みに合わせてカスタマイズすることができます。スキームを共有することも可能です。配色を選択を押して設定を開き、を選択し...

コード補完 (IntelliSense)

JetBrains Rider のコード補完機能に慣れ親しむために、実装の基礎をいくつか紹介します。新しい識別子の入力を開始するとすぐに、自動補完の候補リストが表示されます。を押すと、基本補完の候補リストが表示されます。他の 2 つの補完コマンド、型一致補完および第 2 基本補完は、高度なアルゴリズムを適用して、候補リストにさらに項目を追加します。AI Assistant を有効にしている場合は、周囲のコンテキストに基づいてコードブロック全体を作成できる AI を搭載したコード補完を利用できます。...

言語およびフレームワーク: JSON

JSON 形式は、データの保存と構成ファイルに一般的に使用されます。JetBrains Rider は、JSON ファイルの操作を支援します。構文とフォーマットをチェックします。一般的なタイプの構成ファイルでは、JetBrains Rider はコード補完を提供します。JSON スキーマは、そのようなファイルの構造と内容を記述するための特別な形式です。カスタム JSON スキーマを使用して、JSON ファイルでコード補完を有効にして検証することもできます。JSON5 を有効にする:JetBrai...

言語およびフレームワーク: Markdown

Markdown は、フォーマット要素をプレーンテキストに追加するための軽量のマークアップ言語です。JetBrains Rider は Markdown ファイルを認識し、ハイライト、補完、フォーマットを行う専用エディターを提供し、レンダリングされた HTML をライブプレビューペインに表示します。サポートは CommonMark の仕様に基づいています。新しい Markdown ファイルを作成するデフォルトでは、JetBrains Rider は、.md または .markdown 拡張子を持つすべての...