メインコンテンツへスキップ
バージョン: v18.0.0

エディターサポート

要点:VS Code拡張機能があります。


Relayコンパイラーは、コードに埋め込まれたGraphQLを深く理解しています。私たちはその理解を利用して、Relayでアプリを開発する際の開発者体験を向上させたいと考えています。そのため、v14.0.0以降、新しいRust Relayコンパイラーは、コードエディターで直接言語機能を提供できます。これはつまり

Relayコンパイラーのエラーが、エディターに直接赤い波線として表示されます

GraphQLタグ付きテンプレートリテラル全体でオートコンプリートが利用可能

ホバーすると、Relay固有の機能に関する型情報とドキュメントが表示されます

@deprecatedフィールドは取り消し線でレンダリングされます

フラグメント、フィールド、および型の定義へのクリック移動

一般的なエラーに対するクイックフィックスの提案

Language Server

エディターサポートは、Language Server Protocolを使用して実装されています。これは、さまざまなエディターで使用できることを意味しますが、このリリースと並行して、Terence Bezman氏(Coinbase所属)が公式のVS Code拡張機能を提供しています。

こちらから入手してください!

Relay固有のエディター拡張機能が必要な理由

GraphQL foundationには、GraphQLを一般的にサポートする公式の言語サーバーとVS Code拡張機能があります。これは適切な基本体験を提供できますが、Relayユーザーにとっては、この情報をRelayコンパイラーから直接取得することで、多くの利点が得られます。

  • Relayコンパイラーのエラーが、多くの場合、クイックフィックスの提案とともに「問題」としてエディターに直接表示されます。
  • ホバー情報は、Relay固有の機能とディレクティブを認識し、関連ドキュメントへのリンクを提供できます。