[VSCode] SFTP プラグインの設定ファイルでプロファイルを切替

 Visual Studio Code でいちばんよく使うプラグインは「SFTP」です。サーバーへのファイルアップが FTP ソフト使わずに簡単にできます。サーバー側のファイルとの比較も便利です。

サーバーコンテンツの運用としては、テスト環境、本番環境でアップ先を切り替えることで、安全にコンテンツアップができるようになります。

以下、sftp.json ファイルに設定します。

{
    "name": "sitename", // 設定名
    "protocol": "ftp", // 通信プロトコル(FTP) SFTP 指定も可能
    "secure": true, // セキュア通信(上のと組み合わせて FTPS)
    "remotePath": "/site/path", // サーバー側のパス
    "uploadOnSave": false, // VSCode で保存したファイルを即座にアップロードするかどうか
    "host": "hostname", // ホスト名
    "profiles": { // ここからプロファイル設定
        "prod": { // プロファイル名(prod = 本番として設定)
            "username": "user\\$prod", // 個別ユーザー名
            "password": "password" // 個別パスワード
        },
        "test": { // もうひとつのプロファイル名(test = テストとして設定)
            "username": "user\\$test",
            "password": "password"
        }
    },
    "defaultProfile": "test" // 最初にどのプロファイルを使うか
}

共通で設定する項目についてはルートに、本番とテストで個別に設定が必要な部分は profiles 以下に設定します。ルートとプロファイルに同じものがある場合、プロファイルの中にあるものが採用されます。

今回の環境では Windows Azure を使っているので、FTPS を設定しています。SFTP の場合は protocol に sftp を指定します。

プロファイルの切替は F1 を押して「profile」と入れれば切替できます。


選択しているプロファイルは VSCode の最下段に表示されています。