devcontainerでインストールしたい拡張を共通化する

はじめに

devcontainer はコンテナ内でinstallする拡張機能を記述することができます。

.devcontainer/devcontainer.json

{
    "customizations": {
        "vscode": {
            "settings": {},

            "extensions": [
                "editorconfig.editorconfig",
                "esbenp.prettier-vscode",
                "dbaeumer.vscode-eslint",
                "stylelint.vscode-stylelint"
            ]
        }
    }
}

これによって、containerで必要な拡張機能だけをインストールすることが可能です。
しかし、GitHub Copilotの拡張など、立ち上げようと思っているdevcontainer全てに共通で入れておきたい、ユーザー個人で入れている拡張機能がある場合、.devcontainer/devcontainer.json全てに書くのは不便だなと感じました。

この記事では、ユーザーの立ち上げるdevcontainerに共通で拡張機能をインストールする方法を書きます。

書き方

• VSCodeを立ち上げます
• Command + Shift + Pでコマンドパレットを呼び出し、基本設定: ユーザー設定を開く (JSON)を選択して

settings.yml

{
    // 他の記述...
    "dev.containers.defaultExtensions": [
        "naumovs.color-highlight",
        "github.copilot",
        "github.copilot-chat",
        "streetsidesoftware.code-spell-checker",
    ],
}

こちらを記載した状態でdevcontainerを再度開き直すと、記載した拡張機能も一緒にインストールされます。