gulpでsftp通信でファイルアップロードの自動化

Question

いつもお世話になっております。
現在gulpの勉強中でタイトルのようなことを実現しようとしているのですが、途中で詰まっています。
どなたか聡明なエンジニア様お助けいただけたら幸いです。

##前提・実現したいこと
gulpを使用して、watchで監視してファイルに変更があった際サーバー(sftp)に自動でアップロード

##現在の状況
プラグインはgulp-sftpを使用しています。
該当ファイルの監視とアップロードの自動化はできているのですが、リモート先のパスが固定のため、ローカルパスと同期ができていません。ここ修正できれば完成する所存です。

/************************************************
 * モジュールの読み込みや設定
 ************************************************/

var gulp = require('gulp');
var sftp = require('gulp-sftp');
var fs = require('fs');

var sftpconfig = JSON.parse(fs.readFileSync('sftpconfig.json', 'utf8'));

/************************************************
 * タスク一覧
 ************************************************/

gulp.task('upload', function () {
  gulp.watch("該当ディレクトリ/**", function(){
  gulp.src([
    '該当ディレクトリ/img/*.png',
    '該当ディレクトリ/css/*.css,
    '該当ディレクトリ/js/*.js
  ])
    .pipe($.sftp(sftpconfig))
  });
});

{
    "host"      : "000.000.000.000",
    "port"      : 00,
    "user"      : "hogehoge",
    "keyLocation": "~/.ssh/id_rsa",
    "password"      : "hogehoge",
    "remotePath": "/usr/share/nginx/html/該当サイト/該当ディレクトリ/"
}

今回使用している部分だけソースを書き出しました。
サーバー情報はダミーです。

以上になります。お手数ですがよろしくお願いします。

Answer 1

下記にて力技ですが自己解決しました。

/************************************************
 * モジュールの読み込みや設定
 ************************************************/
var gulp = require('gulp');
var $ = require('gulp-load-plugins')();
var fs = require('fs');

var sftpconfig = JSON.parse(fs.readFileSync('sftpconfig.json', 'utf8')); //サーバー情報を外部ファイルから読み込み

/************************************************
 * タスク一覧
 ************************************************/
//自動アップロードしたい分だけ書く
gulp.task('uploadImg', function () {
  gulp.watch("webroot/img/**", function(){
  var server = sftpconfig.server[0];
  var path = sftpconfig.path[0];
  Object.assign(server, path);
  gulp.src([
    'webroot/img/*.png',
    'webroot/img/*.jpg',
    'webroot/img/*.gif'
  ])
    .pipe($.plumber())
    .pipe($.sftp(server))
  });
});

gulp.task('uploadController', function () {
  gulp.watch("src/Controller/**", function(){
  var server = sftpconfig.server[0];
  var path = sftpconfig.path[1];
  Object.assign(server, path);
    gulp.src([
      'src/Controller/*.php'
    ])
      .pipe($.plumber())
      .pipe($.sftp(server))
  });
});

//最後に一括にまとめる
gulp.task('upload',['uploadImg','uploadController'], function() {
});

{
  "server":[
    {"host": "秘密です","port": 秘密です,"user": "piyopiyo","keyLocation": "~/.ssh/id_rsa","password": "秘密です"}
  ],
  "path":[
    {"remotePath": "/usr/share/nginx/html/hogehoge/webroot/img/"},
    {"remotePath": "/usr/share/nginx/html/hogehoge/src/Controller/"}
  ]
}

省略して書きましたが実際には膨大な数書いてます。
結局調べてよく分からなかったので一つ一つディレクトリーを指定しています。
またディレクトリの指定をwatchの内側で宣言しないと最後に一括でまとめた際に期待した動作になってくれなかったです。（AのデータがBのディレクトリに格納されてしまうような感じです。）
もっと綺麗な書き方があると思いますが、とりあえず目的は達成しましたのでこちらでこの質問は閉めさせてもらいます。
閲覧＆クリップ＆回答ありがとうございました。

Answer 2

リモート先のパスが固定のため、ローカルパスと同期ができていません。

とは、
「img, css, js それぞれのディレクトリの内容物が全部
該当ディレクトリ 直下に入ってしまうので、ディレクトリの構造を維持したままアップロードしたい」
という事でよろしいでしょうか？

意図されている内容と異なるかもしれませんが、とりあえずそのように仮定して解答させていただきます。
（もし異なる場合は期待する動作について詳細の追記をお願いします。）

今回使用されている gulp-sftp についてですが、
こちらは渡されたディレクトリ構造を維持してアップロードを試みてくれるようです。

よって、gulp.src()でディレクトリ構造を含んだ状態で取り出して
pipe()に渡してあげればOK、と言う事になります。

具体的には

gulp.task('upload', function () {
  gulp.watch("target/**/*", function(){
  gulp.src([
    'target/img/**/*.png',
    'target/css/**/*.css',
    'target/js/**/*.js'
  ], {base: 'target'})
    .pipe(sftp(sftpconfig))
  });
});

このような形になるかと思います。

変更天としては2点、

• 各ファイル指定の間に /**/ を追加しました

** はディレクトリを再帰的に辿る事を意味します。
これを入れることによって、target/img/ 等の直下だけでなく、
target/img/this/is/long/path/pic.pngのような深い階層まで構造を維持して取得できます。

• gulp.src()のオプションに base: (該当ディレクトリ) の表記を追加しました

通常、gulp.src()で取得された構造は、ワイルドカード以下になります。
よって、先ほどの例で言うと 'target/img/**/*.png' という表記で取得するとディレクトリ構造は
this/is/long/path/pic.png となり、imgディレクトリは含まれない状態で取得されます。
よって、他のディレクトリの内容と混ざってしまうこととなります。

target/**/*.pngと書けばディレクトリごとに分けられますが、
そうすると今度は無駄なディレクトリまで拾ってしまう可能性があります。

幸い、gulp.src()にはオプションとして、起点となるディレクトリを指定できるので、
今回の場合は {base: 'target'}として、targetディレクトリ以下のディレクトリ構造を
取得するように指定しました。

以上、この２点の変更を行うことで、それぞれのディレクトリ構造を保ったままアップロードが可能となります。

Comments

[minehan]

コメントありがとうございました。
投稿の後に自己解決しました。申し訳ないです。
また返信遅くなってすいませんでした。