1.4. CodeReady Workspaces での Visual Studio コードエクステンションの使用
Red Hat CodeReady Workspaces 2.3 以降、Visual Studio Code(VS Code)拡張をインストールし、CodeReady Workspaces ワークスペースの機能を拡張することができます。vs Code 拡張機能は Che-Theia エディターコンテナーで実行することも、前提条件で独自の分離済みで事前設定されたコンテナーでパッケージ化することもできます。
本ガイドでは以下について説明します。
- CodeReady Workspaces with workspaces で VS コードエクステンションを使用します。
- CodeReady Workspaces プラグインパネル
CodeReady Workspaces プラグインレジストリーで VS コードエクステンションを公開する方法(他の CodeReady Workspaces ユーザーとエクステンションを共有する場合)。
- extension-hosting サイドカーコンテナーおよび devfile でエクステンションの使用は任意です。
- 特定の API がサポートされているか、実装されていないかを示すために VS Code 拡張機能との互換性を確認する方法
1.4.1. VS コードエクステンションの CodeReady Workspaces プラグインレジストリーへの公開 リンクのコピーリンクがクリップボードにコピーされました!
CodeReady Workspaces のユーザーはワークスペースの devfile を使用して、任意のプラグイン(Visual Studio Code(VS Code)拡張としても知られる)を使用できます。このプラグインはプラグインレジストリーに追加でき、ワークスペースのインストールにアクセスできる同じ組織のユーザーが簡単に再利用できます。
一部のプラグインには、コードコンパイルにランタイム専用コンテナーが必要です。そのため、これらのプラグインはランタイムサイドカーコンテナーと VS コード拡張の組み合わせになります。
以下のセクションでは、プラグイン設定の移植性を説明し、プラグインが必要なランタイムコンテナーにエクステンションを関連付けます。
1.4.1.1. meta.yaml ファイルの作成およびプラグインレジストリーへの追加 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat CodeReady Workspaces プラグインレジストリーで VS Code 拡張を公開するには、プラグインのメタデータが必要です。このメタ情報は meta.yaml
ファイルとして提供されます。本セクションでは、エクステンションの meta.yaml
ファイルを作成する方法を説明します。
手順
-
以下のプラグインレジストリーディレクトリーに
meta.yaml
ファイルを作成します。<apiVersion>/plugins/ <publisher>/<plug-inName>/<plug-inVersion>/
meta.yaml
ファイルを編集し、必要な情報を提供します。設定ファイルは、以下の構造に従う必要があります。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- ファイル構造のバージョン。
- 2
- プラグインパブリッシャーの名前。パスのパブリッシャーと同じである必要があります。
- 3
- プラグインの名前。path と同じである必要があります。
- 4
- プラグインのバージョン。path と同じである必要があります。
- 5
- プラグインのタイプ。使用できる値は
Che Plugin
、Che Editor
、Theiaプラグイン、
VS Code 拡張
です。 - 6
- プラグインの短縮名。
- 7
- プラグインのタイトル。
- 8
- プラグインの簡単な説明と、そのプラグインの動作。
- 9
- プラグインロゴへのリンク。
- 10
- オプション。プラグインのソースコードリポジトリーへのリンク。
- 11
- このプラグインが属するカテゴリーを定義します。
Editor
、Debugger
、Formatter
、Language
、Linter、Snippet、Theme
、またはOther
のいずれか
にする必要があります。
- 12
- このセクションを省略すると、VS Code 拡張が Che-Theia IDE コンテナーに追加されます。
- 13
- サイドカーコンテナーを起動する Docker イメージ。例:
eclipse/che-theia-endpoint-runtime:next
- 14
- サイドカーコンテナーで利用可能な最大 RAM。例: "512Mi"この値は、コンポーネント設定のユーザーが上書きされる可能性があります。
- 15
- デフォルトでサイドカーコンテナー用に提供される RAM。たとえば、「256Mi」です。この値は、コンポーネント設定のユーザーが上書きされる可能性があります。
- 16
- サイドカーコンテナーで利用可能なコアまたはミリコアの最大 CPU 容量(「m」で拡張)。例: "500m", "2"この値は、コンポーネント設定のユーザーが上書きされる可能性があります。
- 17
- コアまたはミリコアの CPU 容量(「m」で拡張)。これは、デフォルトでサイドカーコンテナー用に提供されます。たとえば、「125m」です。この値は、コンポーネント設定のユーザーが上書きされる可能性があります。
- 18
- このサイドカーコンテナーで実行される VS コードエクステンションの一覧。