VSCODEでファイル保存時の自動アップロード

投稿日：2024年3月3日

ローカル環境で開発時に、毎回サーバーへファイルをアップロードするのは大変ですよね。フォルダ構成が複雑になってきたりプロジェクトが増えて来たりすると操作ミスの可能性も出てきます。そういう場合に便利な自動SFTPアップロードの設定を記載します。

1.まずはVSCODEでSFTPの拡張機能をインストール

2.設定ファイルを作成

メニューバーの＜表示＞から＜コマンドパレット＞を選択
＞の後に「sftp」と入力　→　「SFTP:Config」を選択

{
  "name": "server_name",  
  "protocol": "sftp",
  "host": "server_ip",
  "username": "myID",
  "password":"myPassWord!",
  "remotePath": "public_html",
  "uploadOnSave":false,
  "connectTimeout":200000,
  "ignore": [
    ".vscode",
    ".git",
    ".DS_Store",
    "sftp.json"
  ]
}

上記説明
“name”：任意の設定名
“protocol”：接続するプロトコル（ftpは21、sftpは22が多い）
“host”：サーバーのIP、ホスト名
“username”：接続する際にユーザーID
“password”：上記パスワード
“remotePath”：サーバー側の転送先ディレクトリのパス
“uploadOnSave”：ファイルを保存した際に、自動でアップロードを行うか
　　　　　　　　　trueだと保存時に自動でアップロードが行われます
“connectTimeout”：タイムアウトの時間
“ignore”：ファイル転送しないファイルの一覧を記載。
　　　　　.vscode、.git、.sftp.jsonは必ず設定

注意

個人で運用しているサーバーや、テストサーバーなどでは自動更新でもいいですが、本番サーバーで運用する場合は危険なので手動更新にしておいた方が無難ですね。