3.4. CodeReady Workspaces での Visual Studio Code 拡張機能の使用
Red Hat CodeReady Workspaces では、Visual Studio Code(VS Code)拡張機能をインストールして CodeReady Workspaces ワークスペースの機能を拡張できます。VS Code 拡張機能は Che-Theia エディターコンテナーで実行できます。または、前提条件を使用して独自の分離されたコンテナーおよび事前に設定されたコンテナーにパッケージ化できます。
本ガイドでは以下の内容について説明します。
- ワークスペースで CodeReady Workspaces で VS Code 拡張機能を使用する。
- CodeReady Workspaces プラグインパネル。
CodeReady Workspaces プラグインレジストリーで VS Code 拡張機能を公開する方法(他の CodeReady Workspaces ユーザーと拡張を共有する場合)。
- extension-hosting サイドカーコンテナーおよび devfile での拡張機能の使用は任意です。
- VS Code 拡張機能の互換性を確認して、特定の API がサポートされていないか、まだ実装されていないかについて通知する方法。
3.4.1. VS Code 拡張機能の CodeReady Workspaces プラグインレジストリーへの公開 リンクのコピーリンクがクリップボードにコピーされました!
CodeReady Workspaces のユーザーはワークスペース devfile を使用して、Visual Studio Code(VS Code)拡張とも呼ばれる任意のプラグインを使用できます。このプラグインをプラグインレジストリーに追加すると、そのワークスペースインストールにアクセスできるのと同じ組織のすべてのユーザーが簡単に再利用できます。
プラグインによっては、コードコンパイルにランタイム専用のコンテナーが必要です。このファクトは、これらのプラグインがランタイムサイドカーコンテナーと VS Code 拡張機能の組み合わせを作成します。
以下のセクションでは、プラグイン設定の移植性を説明し、拡張機能をプラグインが必要とするランタイムコンテナーに関連付けます。
3.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
- プラグインの名前。パスで使用されているものと同じである必要があります。
- 4
- プラグインのバージョン。パスで使用されているものと同じである必要があります。
- 5
- プラグインのタイプ。使用できる値は
Che Plugin、Che Editor、Theia plugin、VS Code extensionです。 - 6
- プラグインの省略名。
- 7
- プラグインのタイトル。
- 8
- プラグインとその機能についての簡単な説明。
- 9
- プラグインロゴへのリンク。
- 10
- オプション。プラグインのソースコードリポジトリーへのリンク。
- 11
- このプラグインが属するカテゴリーを定義します。
Editor、Debugger、Formatter、Language、Linter、Snippet、Theme、またはOtherのいずれかにする必要があります。 - 12
- このセクションを省略すると、VS Code 拡張機能が Che-Theia IDE コンテナーに追加されます。
- 13
- サイドカーコンテナーが起動する Docker イメージ。例:
theia-endpoint-image - 14
- サイドカーコンテナーで利用可能な最大 RAM。例: "512Mi"この値は、コンポーネント設定でユーザーによって上書きされる可能性があります。
- 15
- デフォルトでサイドカーコンテナーに指定される RAM。例: "256Mi"この値は、コンポーネント設定でユーザーによって上書きされる可能性があります。
- 16
- サイドカーコンテナーで利用可能なコアまたはミリコア単位 (末尾に m が付く) の CPU の最大量。例: "500m"、"2"この値は、コンポーネント設定でユーザーによって上書きされる可能性があります。
- 17
- デフォルトでサイドカーコンテナーに指定されるコアまたはミリコア単位 (末尾に m が付く) の CPU 量。例: "125m"この値は、コンポーネント設定でユーザーによって上書きされる可能性があります。
- 18
- このサイドカーコンテナーで実行される VS Code 拡張機能の一覧。