リモートサーバにプリインストールする VS Code 拡張機能を設定する

こんにちは、ロジカル・アーツの笹原です。

短いですが VS Code のリモート開発に関する Tips をご紹介します。

デフォルト拡張機能の設定

私はよく EC2 インスタンス（仮想サーバ）に Remote - SSH で接続して検証・開発を行うのですが、その際にデフォルトで入っていてほしい拡張機能がいくつかあります。
code コマンドで拡張機能をインストールするスクリプトを事前に用意しておき、接続後に実行してまとめてインストールすることもできなくはないですが、できれば接続時にインストールされている状態が望ましいです。

これは、ユーザ設定の方の settings.json*1 で remote.SSH.defaultExtensions にインストールしたい拡張機能の ID を記述することで実現できます。

例
settings.json

    "remote.SSH.defaultExtensions": [
        "timonwong.shellcheck",
        "foxundermoon.shell-format",
        "ms-azuretools.vscode-docker",
        "mutantdino.resourcemonitor"
    ]

コンテナの場合もほぼ同様で、remote.containers.defaultExtensions に拡張機能 ID を書きます。

    "remote.containers.defaultExtensions": [
        "mutantdino.resourcemonitor"
    ]

おわりに

これらの設定はすべてのリモートサーバ・コンテナに適用されるようなので、特定のサーバ・コンテナにだけインストールしたい/したくないという場合には向いていないです。その場合は VS Code で接続した後に必要でないものをアンインストールしたり、上記の設定をせず code コマンドを使用したインストールスクリプトを用意したりといった工夫が必要になるかと思います。

参考

• Developing on Remote Machines using SSH and Visual Studio Code
• Developing inside a Container using Visual Studio Code Remote Development

*1:グローバルに適用される方です。