VSCodeのSFTPプラグインで複数ホストを設定する方法

VSCodeのプラグイン「SFTP」で複数の接続先を設定する方法です。ちょっと手間取りましたが、結論から言うとちゃんと複数ホストを設定できました。

いくつかのAIに聞いてみても正しい答えが得れられなかったので、シェアします。

VSCodeのSFTPプラグインとは

今回の環境で使っている「SFTP」プラグインは以下のものです。バージョンは1.16.1を使っています。

SFTP - Visual Studio Marketplace
Extension for Visual Studio Code - SFTP/FTP sync

sftp.jsonの内容

VSCodeを使っている人なら説明不要かも知れませんが、コマンドパレットの開き方は、

[Ctrl] + [Shift] + [P] (macOSでは[Command]+[Shift]+[P])

です。

コマンドパレットを開き「SFTP:Config」を選択します。

.jsonファイルが開いたら、以下の書式で複数ホストを定義できます。ポイントは「context」の値をユニークにすることです。重複していると全てのホストがSFTPエクスプローラーに表示されません。

[
  {
    "name": "host_A",
    "context": "C:\\svn\\svn_A",
    "host": "hoge.co.jp",
    "protocol": "sftp",
    "port": 22,
    "username": "user",
    "remotePath": "/home/user/www/user_A",
    "privateKeyPath": "C:\\Users\\user\\.ssh\\hoge_key",
    "uploadOnSave": true,
    "ignore": [
        ".vscode",
        ".git",
        ".DS_Store",
        "sftp.json"
      ]
  },
  {
    "name": "host_B",
    "context": "C:\\svn\\svn_B",
    "host": "hoge.co.jp",
    "protocol": "sftp",
    "port": 22,
    "username": "user",
    "remotePath": "/home/user/www/user_B",
    "privateKeyPath": "C:\\Users\\user\\.ssh\\hoge_key",
    "uploadOnSave": true,
    "ignore": [
        ".vscode",
        ".git",
        ".DS_Store",
        "sftp.json"
      ]
  }  
]

なお、この情報は、以下のstackoverflowのリンク先から得たものです。

Visual Studio Code SFTP to multiple servers
In PhpStorm, there is a way to configure multiple SFTP endpoints and chose which server you want to upload to. I'm looki...

定義した全てのホストがSFTPエクスプローラに表示されたことが確認できたら作業完了です。お疲れ様でした。

タイトルとURLをコピーしました