5.4. VS Code 拡張のメタデータの公開

CodeReady Workspaces ワークスペースで VS Code 拡張機能を使用するには、CodeReady Workspaces が拡張機能を記述するメタデータを使用する必要があります。CodeReady Workspaces プラグインレジストリーは、一般的な VS Code 拡張機能についてのメタデータを公開する静的 Web サイトです。

この記事では、拡張機能設定のmeta.yamlファイルを使用して、CodeReady Workspaces プラグインレジストリーで利用できない、追加の拡張機能のメタデータを公開する方法を説明します。

既存のプラグインレジストリーにプラグインを追加する方法は、「Che プラグインレジストリーへの VS Code 拡張機能の追加」を参照してください。

前提条件

  • VS Code 拡張機能で必要な場合には、必要とされる関連付けられたコンテナーイメージが利用可能になります。

手順

  1. meta.yaml ファイルを作成します。

  2. meta.yaml ファイルを編集し、必要な情報を指定します。ファイルには、以下の構造が必要です。 

    apiVersion: v2                                                   1
publisher: myorg                                                 2
name: my-vscode-ext                                              3
version: 1.7.2                                                   4
type: value                                                      5
displayName:                                                     6
title:                                                           7
description:                                                     8
icon: https://www.eclipse.org/che/images/logo-eclipseche.svg     9
repository:                                                     10
category:                                                       11
spec:
  containers:                                                   12
    - image:                                                    13
      memoryLimit:                                              14
      memoryRequest:                                            15
      cpuLimit:                                                 16
      cpuRequest:                                               17
  extensions:                                                   18
          - https://github.com/redhat-developer/vscode-yaml/releases/download/0.4.0/redhat.vscode-yaml-0.4.0.vsix
          - https://github.com/SonarSource/sonarlint-vscode/releases/download/1.16.0/sonarlint-vscode-1.16.0.vsix
    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 拡張機能の一覧。
  3. GitHub または GitLab に公開されたファイルコンテンツで gist を作成し、meta.yaml ファイルを HTTP リソースとして公開します。