概要

VS CodeのRemote-SSHとDev Containers拡張機能を併用して開発環境を構築していると、以下のような違いに気づくことがあります：

この挙動の違いを整理し、.code-workspaceを用いる利便性や注意点を解説します.

`.code-workspace`とは

.code-workspaceは、VS Codeのワークスペース設定ファイルです.以下の情報などを含めることができます：

{
  "folders": [
    {
      "uri": "vscode-remote://ssh-remote+myserver/home/ubuntu/project"
    }
  ],
  "remoteAuthority": "ssh-remote+myserver"
}

このように記述された .code-workspace を開くと、VS Code は remoteAuthority に従って自動的にSSH接続を行い、リモートの対象フォルダを開きます.

さらに、開いたフォルダに開発コンテナで作成した .code-workspace を開くと開発コンテナへ接続することができます。

vscodeで作成したworkspaceを開きます。(開発コンテナに1度で接続するためには、開発コンテナへ接続した状態にします。)

ファイル -> 名前をつけてワークスペースを保存

ローカルを表示します。をクリックし、ローカルに.code-workspaceを保存することができます。

作成後に再読み込みを必要とする場合があります。

つまり、workspaceファイルを使えば一度の操作でSSH接続＋開発コンテナ接続まで完了し、パスフレーズの入力も1回で済みます.

この動作の背景には、.code-workspaceに含まれるremoteAuthority情報がVS Codeにとっての完全なリモート接続情報として機能し、初期化手順を省略できることがあります.

.code-workspaceファイルをローカルに用意しておくことで、以下のような利便性が得られます：

.code-workspaceファイルを使用していても、以下のような変更は自動的に反映されません.

そのため、開発コンテナの設定を変更した際は、再度 .code-workspaceを作成しなおしてください.

これを行わないと、古いコンテナがそのまま動作し続けてしまうため、変更が反映されず不具合や意図しない挙動の原因になります.