Skip to main content

devcontainer.json ファイルへの機能の追加

機能を使用すると、dev container 構成にツール、ランタイム、またはライブラリをすばやく追加できます。

各機能は、インストール コードと開発コンテナー構成の自己完結型ユニットであり、さまざまな基本コンテナー イメージで動作するように設計されています。 各機能を使用すると、codespace イメージにツール、ランタイム、またはライブラリをすばやく追加できます。 詳しくは、開発コンテナーの Web サイトで、使用できる機能機能の仕様に関するページをご覧ください。

機能は、VS Code からか、GitHub.com のリポジトリから devcontainer.json ファイルに追加できます。 この記事のタブを使用して、これらの機能を追加する各方法の手順を表示します。

devcontainer.json ファイルへの機能の追加

  1. GitHub.com のリポジトリに移動し、devcontainer.json ファイルを見つけて、 をクリックしてファイルを編集します。

    devcontainer.json ファイルがない場合は、ここで作成します。 詳しくは、「開発コンテナーの概要」を参照してください。

  2. ファイル エディターの右側にある [Marketplace] タブで、追加する機能を参照または検索し、その機能の名前をクリックします。

    [Marketplace] タブのスクリーンショット。検索ボックスに「Terra」と入力されており、検索結果に Terraform 機能が表示されています。

  3. [インストール] で、コード スニペットをクリックしてクリップボードにコピーし、devcontainer.json ファイル内の features オブジェクトにスニペットを貼り付けます。

    [Marketplace] タブのスクリーンショット。Terraform のインストール コードのスニペットが表示されています。

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {},
         // ...
     }
    
  4. 既定では、最新バージョンの機能が使用されます。 別のバージョンを選んだり、機能の他のオプションを構成したりするには、[オプション] の下に表示されているプロパティを展開して使用可能な値を表示し、devcontainer.json ファイル内のオブジェクトを手動で編集してオプションを追加します。

    [Marketplace] タブの [オプション] セクションのスクリーンショット。[バージョン] と [tflint] のプロパティが展開されています。

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {
             "version": "1.1",
             "tflint": "latest"
         },
         // ...
     }
    
  5. devcontainer.json ファイルへの変更をコミットします。

構成の変更は、リポジトリから作成された新しい codespace で有効になります。 既存の codespace で変更を有効にするには、devcontainer.json ファイルの更新を codespace にプルしてから、codespace のコンテナーをリビルドする必要があります。 詳しくは、「開発コンテナーの概要」を参照してください。

ローカルで作業していて、codespace に接続されていないときに VS Code に機能を追加するには、"Dev Containers" 拡張機能がインストールされ、有効になっている必要があります。 この拡張機能の詳細については、「VS Code Marketplace」を参照してください。

  1. Shift+Command+P (Mac) または Ctrl+Shift+P (Windows/Linux) を使用して、VS Code Command Palette にアクセスします。

  2. 「add dev」と入力を始め、 [Codespaces: 開発コンテナー構成ファイルの追加] をクリックします。

    「開発の追加」と入力され、[Codespaces: 開発コンテナー構成ファイルの追加] が一覧に表示されている、コマンド パレットのスクリーンショット。

  3. [Modify your active configuration] (アクティブな構成の変更) をクリックします。

  4. 機能の選択を更新し、 [OK] をクリックします。

  5. codespace で作業している場合は、右下隅にプロンプトが表示されます。 コンテナーをリビルドし、作業中の codespace に変更を適用するには、 [今すぐリビルド] をクリックします。

    "開発コンテナー構成が変更されています" というメッセージのスクリーンショット。 この下には [今すぐリビルド] ボタンがあります。