Visual Studio CodeのRemote Developmentを設定する

開発環境として、Visual Studio CodeでRemote Developmentのセットアップ方法についてまとめてみました。

構成

Visual Studio CodeのExtensionsのアイコンをクリックし、 Remote - SSH をインストールします。

Remote Explorerのアイコンが出てくるため、こちらをクリックし、歯車のアイコンをクリックし、SSH構成ファイルを選択します。通常は C:\Users\User Name\.ssh/config でよいかと思います。

新規にSSHターゲットを追加します。sshのコマンドのフォーマットでログイン設定を登録します。 C:\Users\User Name\.ssh/config に設定が追加されていることが確認できます。

追加したSSHターゲットの右横にアイコンをクリックし、新規ウインドでホストに接続します。

プラットフォームの種類を聞かれるため、 Linux を選択します。

フィンガープリントを聞かれるため、続行をクリックします。

Ubuntu側では .vscode-server ディレクトリが作成され、必要なファイルが自動的にダウンロードされます。

初期設定では、ログインパスワードを聞かれるため、公開鍵認証を使ってログインする設定を行います。設定方法はターミナルを使ってログインする方法と変わりません。

Windowsを使っているので、PowerShellで公開鍵と秘密鍵を生成します。

> ssh-keygen

C:\Users\User Name\.ssh/id_rsa とC:\Users\User Name\.ssh/id_rsa.pub が生成されます。

Ubuntu側にログインし、公開鍵認証の設定を行っていきます。

$ mkdir .ssh
$ chmod 700 ./.ssh/

id_rsa.pubファイルをUbuntuに転送しておきます。

$ cd .ssh/
$ cat ./id_rsa.pub >> ./authorized_keys

Windows 10に戻り、Visual Studio CodeのExtensionsのアイコンをクリックしすると、LOCALと接続したSSHターゲットのパッケージ情報が確認できるようになります。

Pythonのコードを書きたい場合は、MicrosoftのPythonの拡張機能をインストールします。

Pythonで検索して、拡張機能の画面にいくと、 Install in SSH: <SSHターゲット> という表示に変わっています。

Pythonの拡張機能がリモート側にインストールされることが分かります。

Install in SSH: <SSHターゲット> をクリックして、拡張機能をインストールします。

Pythonの仮想環境についても準備しておきます。

プロジェクトフォルダにvenvの環境をインストールします。

$ python3 --version
Python 3.8.10
$ sudo apt install python3.8-venv
$ mkdir <project directory>
$ cd <project directory>
$ python3 -m venv venv

Visual Studio Codeのプロジェクトフォルダを開き、Terminalを開くと、自動的にvenvの環境がactivateされるようになります。

$ source /home/username/project_directory/venv/bin/activate
(venv) $

Pythonのコードを書いていくと、Visual Studio Codeの拡張機能により入力補完など便利な機能が利用できるようになっていることが分かります。

設定は以上となります。