自動でRemote WSLするVScodeのworkspaceを設定する

概要

VSCodeでWSLを扱うときに、ステータスバーから接続したりWSLから code .を実行するのは面倒ですので、workspaceファイルでVSCodeを開いてその時にWSLにも自動で接続するようにしました。

対象

• Windows10以上
• Visual Studio Code 1.53.2 以上をインストール済
• WSL or WSL2 設定済み
• VScode内でRemote-WSLの拡張機能をインストール済

コード

.code-workspaceファイルの中身にこれを書いたら終わりです。

{
    "remoteAuthority": "wsl+ubuntu" ,

    "settings": {
        "terminal.integrated.cwd": "/home/username/aaa",
    },

    "folders": [
        {
            "path": "C:/Users/username/aaa/bbb"
        },
        {
            "path": "C:/Users/username/aaa/ddd"
        }
    ],
}

解説

remoteAuthority

"remoteAuthority": "wsl+ubuntu"

これを書くことでワークスペースを開いたときに自動で接続するようになります。ubuntuの部分はWSL用のディストリビューションを記述します。Debianの人はwsl+debianです。

terminal.integrated.cwd

"terminal.integrated.cwd": "/home/username/aaa"

規定のターミナルをsettings 内で設定します。パスの部分はなんでも問題ないですが、WSLのルートから記述するようにしてください。Windowsの方で書くとエラーが発生する可能性があります。

folders

    "folders": [
        {
            "path": "C:/Users/username/aaa/bbb"
        }
    ],

ワークスペース内で開きたいフォルダを好きなだけ書いてください。こちらは反対に，Windowsのルートからパスを書きます。

おわりに

昔見たremoteAuthorityの記事が全然見つからなかったので備忘録として書きました。
その他いい方法や間違いがあればコメントでよろしくお願いします。