@qse/ssh-sftp 1.0.0 → 1.1.0

package/README.md

@@ -36,6 +36,8 @@ npm i @qse/ssh-sftp -D
 
 ### `.sftprc.json`
 
+schema定义 http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/sftprc.schema.json
+
 | 字段名           | 类型                                                 | 描述                                           | 默认值                 |
 | ---------------- | ---------------------------------------------------- | ---------------------------------------------- | ---------------------- |
 | localPath        | `string`                                             |                                                | `'dist'`               |

package/lib/cli.js

@@ -7,21 +7,14 @@ const {
   sshSftpShowUrl,
   sshSftpShowConfig
 } = require('./index');
-
 const fs = require('fs');
-
 const ora = require('ora');
-
 const {
   exitWithError
 } = require('./utils');
-
 const updateNotifier = require('update-notifier');
-
 const pkg = require('../package.json');
-
 const presets = require('./presets');
-
 updateNotifier({
   pkg,
   updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
@@ -43,48 +36,37 @@ require('yargs').usage('使用: $0 [command] \n\n代码：svn://192.168.10.168/e
   v: 'version',
   h: 'help'
 }).argv;
-
 function getOpts() {
   isRoot();
-
   if (!fs.existsSync('.sftprc.json')) {
     return exitWithError('没找到 .sftprc.json 文件，请先执行 ssh-sftp init');
   }
-
   const opts = fs.readFileSync('.sftprc.json', 'utf-8');
   return JSON.parse(opts);
 }
-
 function isRoot() {
   if (!fs.existsSync('package.json')) {
     exitWithError('请在项目的根目录运行(package.json所在的目录)');
   }
 }
-
 function upload({
   clear,
   yes
 }) {
   const opts = getOpts();
-
   if (clear === false) {
     opts.cleanRemoteFiles = false;
   }
-
   if (yes) {
     opts.skipPrompt = true;
   }
-
   sshSftp(opts);
 }
-
 function generateDefaultConfigJSON() {
   isRoot();
-
   if (fs.existsSync('.sftprc.json')) {
     return exitWithError('已存在 .sftprc.json 文件，请勿重复生成');
   }
-
   fs.writeFileSync('.sftprc.json', JSON.stringify({
     $schema: 'http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/sftprc.schema.json',
     localPath: '/path/to/localDir',
@@ -102,25 +84,20 @@ function generateDefaultConfigJSON() {
   });
   ora().succeed('.sftprc.json 生成在项目根目录');
 }
-
 function ls(argv) {
   if (!argv.u && !argv.d && !argv.i) {
     argv.u = true;
     argv.d = true;
     argv.i = true;
   }
-
   sshSftpLS(getOpts(), argv);
 }
-
 function showUrl() {
   sshSftpShowUrl(getOpts());
 }
-
 function showConfig() {
   sshSftpShowConfig(getOpts());
 }
-
 function showPresets() {
   console.log(JSON.stringify(presets, null, 2));
 }

package/lib/index.js

@@ -1,33 +1,23 @@
 "use strict";
 
 const Client = require('ssh2-sftp-client');
-
 const ora = require('ora');
-
 const glob = require('glob');
-
 const fs = require('fs');
-
 const minimatch = require('minimatch');
-
 const inquirer = require('inquirer');
-
 const {
   exitWithError,
   warn
 } = require('./utils');
-
 const chalk = require('chalk');
-
 const {
   presets,
   servers
 } = require('./presets');
-
 const path = require('path');
-/** @type {Options} */
-
 
+/** @type {Options} */
 const defualtOpts = {
   localPath: 'dist',
   noWarn: false,
@@ -36,6 +26,7 @@ const defualtOpts = {
   ignore: ['**/*.LICENSE.txt'],
   securityLock: true
 };
+
 /**
  * get upload files
  *
@@ -43,7 +34,6 @@ const defualtOpts = {
  * @param {string} remotePath
  * @param {string[]} ignore
  */
-
 function getFilesPath(localPath, remotePath, ignore) {
   const files = glob.sync(`${localPath}/**/*`, {
     ignore: getSafePattern(ignore, localPath),
@@ -56,6 +46,7 @@ function getFilesPath(localPath, remotePath, ignore) {
     };
   });
 }
+
 /**
  * get remote ls deep
  *
@@ -67,8 +58,6 @@ function getFilesPath(localPath, remotePath, ignore) {
  * @param {FilesOptions} [options]
  * @return {Promise<{isDir:boolean;path:string}[]>}
  */
-
-
 async function getRemoteDeepFiles(sftp, remotePath, options) {
   const {
     patterns
@@ -77,13 +66,10 @@ async function getRemoteDeepFiles(sftp, remotePath, options) {
    * @param {string} remotePath
    * @returns {Promise<string[]|string>}
    */
-
   async function getFiles(remotePath, data = []) {
     const list = await sftp.list(remotePath);
-
     for (const item of list) {
       const path = remotePath + '/' + item.name;
-
       if (item.type === 'd') {
         data.push({
           isDir: true,
@@ -97,30 +83,27 @@ async function getRemoteDeepFiles(sftp, remotePath, options) {
         });
       }
     }
-
     return data;
   }
-
   const ls = (await getFiles(remotePath)).filter(o => o.path);
-
   if (patterns.length > 0) {
     let tmp = ls;
     const safePatterns = getSafePattern(patterns, remotePath);
     tmp = tmp.filter(o => safePatterns.some(reg => minimatch(o.path, reg)));
     return tmp;
   }
-
   return ls;
 }
-
 function ensureDiff(local, remote) {
   return remote.map(file => {
     const isSame = local.some(local => local.remotePath === file.path);
-    return { ...file,
+    return {
+      ...file,
       isSame
     };
   });
 }
+
 /**
  * @typedef {Object} Options
  * @property {string} [localPath]
@@ -133,12 +116,27 @@ function ensureDiff(local, remote) {
  * @property {boolean} [keepAlive]
  * @property {boolean} [noWarn]
  * @property {boolean} [skipPrompt]
+ * @property {{remotePath:string;connectOptions?:import('ssh2').ConnectConfig}[]} [targets]
  * @param {Options} opts
  */
 
-
 async function sshSftp(opts) {
   opts = parseOpts(opts);
+  const results = [];
+  // 这里只返回第一个目标的结果，是为了兼容以前的代码
+  for (const target of opts.targets) {
+    results.push(await _sshSftp({
+      ...opts,
+      ...target
+    }));
+  }
+  return results[0];
+}
+
+/**
+ * @param {Options} opts
+ */
+async function _sshSftp(opts) {
   const {
     deployedURL,
     sftpURL
@@ -146,14 +144,11 @@ async function sshSftp(opts) {
   console.log('部署网址:', chalk.green(deployedURL));
   const spinner = ora(`连接服务器 ${sftpURL}`).start();
   const sftp = new Client();
-
   try {
     await sftp.connect(opts.connectOptions);
     spinner.succeed(`已连接 ${sftpURL}`);
-
     if (!(await sftp.exists(opts.remotePath))) {
       let confirm = false;
-
       if (opts.skipPrompt) {
         confirm = true;
       } else {
@@ -164,20 +159,17 @@ async function sshSftp(opts) {
         });
         confirm = ans.confirm;
       }
-
       if (confirm) {
         await sftp.mkdir(opts.remotePath, true);
       } else {
         process.exit();
       }
     }
-
     let remoteDeletefiles = [];
     let localUploadFiles = [];
     spinner.start('对比本地/远程的文件数量');
     localUploadFiles = getFilesPath(opts.localPath, opts.remotePath, opts.ignore || []);
     spinner.succeed(`本地文件数量：${localUploadFiles.length}`);
-
     if (opts.cleanRemoteFiles) {
       remoteDeletefiles = await getRemoteDeepFiles(sftp, opts.remotePath, {
         patterns: opts.cleanRemoteFiles === true ? [] : opts.cleanRemoteFiles
@@ -190,7 +182,6 @@ async function sshSftp(opts) {
         showDeleteFile: Symbol()
       };
       let confirm = Confirm.delete;
-
       if (remoteDeletefiles.length > localUploadFiles.length && !opts.skipPrompt) {
         const showSelect = async () => {
           const {
@@ -215,14 +206,11 @@ async function sshSftp(opts) {
           });
           return confirm;
         };
-
         do {
           confirm = await showSelect();
-
           if (confirm === Confirm.stop) {
             process.exit();
           }
-
           if (confirm === Confirm.showDeleteFile) {
             const diffFiles = ensureDiff(localUploadFiles, remoteDeletefiles);
             diffFiles.forEach(o => {
@@ -232,42 +220,33 @@ async function sshSftp(opts) {
           }
         } while (confirm === Confirm.showDeleteFile);
       }
-
       if (confirm === Confirm.delete) {
         spinner.start('开始删除远程文件');
         remoteDeletefiles = mergeDelete(remoteDeletefiles);
-
         for (const i in remoteDeletefiles) {
           const o = remoteDeletefiles[i];
           spinner.text = `[${i + 1}/${remoteDeletefiles.length}] 正在删除 ${o.path}`;
           if (o.isDir) await sftp.rmdir(o.path, true);else await sftp.delete(o.path);
         }
-
         spinner.succeed(`已删除 ${opts.remotePath}`);
       }
     }
-
     spinner.start(`开始上传 ${opts.localPath} 到 ${opts.remotePath}`);
-
     if (Array.isArray(opts.ignore) && opts.ignore.length > 0) {
       for (const i in localUploadFiles) {
         const o = localUploadFiles[i];
         spinner.text = `[${i}/${localUploadFiles.length}] 正在上传 ${o.localPath} 到 ${o.remotePath}`;
-
         if (fs.statSync(o.localPath).isDirectory()) {
           if (!(await sftp.exists(o.remotePath))) {
             await sftp.mkdir(o.remotePath);
           }
-
           continue;
         }
-
         await sftp.fastPut(o.localPath, o.remotePath);
       }
     } else {
       await sftp.uploadDir(opts.localPath, opts.remotePath);
     }
-
     spinner.succeed(`已上传 ${opts.localPath} 到 ${opts.remotePath}`);
     return {
       sftp,
@@ -275,7 +254,6 @@ async function sshSftp(opts) {
     };
   } catch (error) {
     spinner.fail('异常中断');
-
     if (error.message.includes('sftpConnect')) {
       exitWithError(`登录失败，请检查 connectOptions 配置项\n原始信息：${error.message}`);
     } else {
@@ -283,51 +261,51 @@ async function sshSftp(opts) {
     }
   } finally {
     if (!opts.keepAlive) {
-      sftp.end();
+      await sftp.end();
     }
   }
 }
+
 /**
  * @param {Options} opts
  * @param {{d:boolean,u:boolean,i:boolean}} lsOpts
  */
-
-
 async function sshSftpLS(opts, lsOpts) {
   opts = parseOpts(opts);
+  for (const target of opts.targets) {
+    await _sshSftpLS({
+      ...opts,
+      ...target
+    }, lsOpts);
+  }
+}
+async function _sshSftpLS(opts, lsOpts) {
   const sftp = new Client();
-
   try {
     await sftp.connect(opts.connectOptions);
-
     if (lsOpts.d) {
       if (opts.cleanRemoteFiles) {
         const ls = await getRemoteDeepFiles(sftp, opts.remotePath, {
           patterns: opts.cleanRemoteFiles === true ? [] : opts.cleanRemoteFiles
         });
         console.log(`删除文件 ${opts.remotePath}(${ls.length}):`);
-
         for (const o of ls) {
           console.log(`  - ${o.path}`);
         }
       }
     }
-
     if (lsOpts.i && Array.isArray(opts.ignore) && opts.ignore.length > 0) {
       let ls = glob.sync(`${opts.localPath}/**/*`);
       ls = ls.filter(s => getSafePattern(opts.ignore, opts.localPath).some(reg => minimatch(s, reg)));
       console.log(`忽略文件 (${ls.length}):`);
-
       for (const s of ls) {
         console.log(`  - ${s}`);
       }
     }
-
     if (lsOpts.u) {
       if (opts.ignore && opts.ignore.length > 0) {
         const ls = getFilesPath(opts.localPath, opts.remotePath, opts.ignore);
         console.log(`上传文件 (${ls.length}): `);
-
         for (const o of ls) {
           console.log(`  + ${o.localPath}`);
         }
@@ -338,14 +316,13 @@ async function sshSftpLS(opts, lsOpts) {
   } catch (error) {
     console.error(error);
   } finally {
-    sftp.end();
+    await sftp.end();
   }
 }
+
 /**
  * @param {{isDir:boolean;path:string}[]} files
  */
-
-
 function mergeDelete(files) {
   let dirs = files.filter(o => o.isDir);
   dirs.forEach(({
@@ -355,122 +332,125 @@ function mergeDelete(files) {
   });
   return files;
 }
+
 /**
  * @param {string[]} patterns
  * @param {string} prefixPath
  */
-
-
 function getSafePattern(patterns, prefixPath) {
   const safePatterns = patterns.map(s => s.replace(/^[\.\/]*/, prefixPath + '/')).reduce((acc, s) => [...acc, s, s + '/**/*'], []);
   return safePatterns;
 }
+
 /**
  * @param {Options} opts
  */
-
-
 function parseOpts(opts) {
   opts = Object.assign({}, defualtOpts, opts);
   process.env.__SFTP_NO_WARN = opts.noWarn;
-
   const pkg = require(path.resolve('package.json'));
-
   if (!pkg.name) {
     exitWithError('package.json 中的 name 字段不能为空');
   }
-
   if (pkg.name.startsWith('@')) {
     // 如果包含scope需要无视掉
     pkg.name = pkg.name.replace(/@.*\//, '');
   }
-
   if (opts.preset && opts.preset.server) {
     if (!servers[opts.preset.server]) exitWithError('未知的 preset.server');
-    const server = { ...servers[opts.preset.server]
+    const server = {
+      ...servers[opts.preset.server]
     };
     opts.connectOptions = server;
   }
-
   if (opts.preset && opts.preset.context) {
     if (!presets[opts.preset.context]) exitWithError('未知的 preset.context');
-    const preset = { ...presets[opts.preset.context]
+    const preset = {
+      ...presets[opts.preset.context]
     };
     const folder = opts.preset.folder || pkg.name;
     preset.remotePath = path.join(preset.remotePath, folder);
     opts = Object.assign({}, preset, opts);
   }
-
   if (!fs.existsSync(opts.localPath)) {
     exitWithError(`localPath 配置错误，未找到需要上传的文件夹(${opts.localPath})`);
   }
-
   if (!fs.statSync(opts.localPath).isDirectory()) {
     exitWithError('localPath 配置错误，必须是一个文件夹');
   }
-
-  if (!opts.remotePath) {
-    exitWithError('remotePath 未配置');
+  opts.connectOptions = {
+    ...opts.connectOptions,
+    readyTimeout: 2 * 60 * 1000
+  };
+  opts.targets = opts.targets || [];
+  if (opts.targets.length === 0 && !opts.remotePath) {
+    exitWithError('remotePath 或 targets 未配置');
+  }
+  if (opts.targets.length === 0) {
+    opts.targets.push({
+      remotePath: opts.remotePath,
+      connectOptions: opts.connectOptions
+    });
+  } else {
+    opts.targets.forEach(target => {
+      target.connectOptions = target.connectOptions || opts.connectOptions;
+    });
+  }
+  if (opts.targets.length > 1 && opts.keepAlive) {
+    exitWithError('keepAlive 选项在多目标上传时不支持，请设置为 false');
   }
-
   if (typeof opts.securityLock !== 'boolean') {
     opts.securityLock = true;
   }
-
   if (opts.securityLock === false) {
     warn('请确保自己清楚关闭安全锁(securityLock)后的风险');
   } else {
-    if (!opts.remotePath.includes(pkg.name)) {
-      exitWithError([`remotePath 中不包含项目名称`, `为防止错误上传/删除和保证服务器目录可读性，你必须让remotePath中包含你的项目名称`, `remotePath：${opts.remotePath}`, `项目名称：${pkg.name} // 源自 package.json 中的 name 字段，忽略scope字段`, `\n你可以设置 "securityLock": false 来关闭这个验证`].join('\n'));
+    for (const target of opts.targets) {
+      if (!target.remotePath.includes(pkg.name)) {
+        exitWithError([`remotePath 中不包含项目名称`, `为防止错误上传/删除和保证服务器目录可读性，你必须让remotePath中包含你的项目名称`, `remotePath：${target.remotePath}`, `项目名称：${pkg.name} // 源自 package.json 中的 name 字段，忽略scope字段`, `\n你可以设置 "securityLock": false 来关闭这个验证`].join('\n'));
+      }
     }
   }
-
   if (opts.ignore) {
     opts.ignore = [opts.ignore].flat(1).filter(Boolean);
   }
-
   if (opts.cleanRemoteFiles === true) {
     opts.cleanRemoteFiles = [];
   }
-
   if (opts.cleanRemoteFiles) {
     opts.cleanRemoteFiles = [opts.cleanRemoteFiles].flat(1).filter(Boolean);
   }
-
   return opts;
 }
-
-function getDeployURL(opts) {
-  const _r = opts.connectOptions;
-  const sftpURL = `sftp://${_r.username}:${_r.password}@${_r.host}:${_r.port}/${opts.remotePath}`;
+function getDeployURL(target) {
+  const _r = target.connectOptions;
+  const sftpURL = `sftp://${_r.username}:${_r.password}@${_r.host}:${_r.port}/${target.remotePath}`;
   let deployedURL = '未知';
-
   for (const context in presets) {
     const preset = presets[context];
-    if (!opts.remotePath.startsWith(preset.remotePath)) continue;
-    const fullPath = opts.remotePath.replace(preset.remotePath, '').slice(1);
+    if (!target.remotePath.startsWith(preset.remotePath)) continue;
+    const fullPath = target.remotePath.replace(preset.remotePath, '').slice(1);
     deployedURL = ['http://www.zhidianbao.cn:8088', context, fullPath, ''].join('/');
     break;
   }
-
   return {
     sftpURL,
     deployedURL
   };
 }
+
 /**
  * @param {Options} opts
  */
-
-
 function sshSftpShowUrl(opts) {
   opts = parseOpts(opts);
-  const {
-    deployedURL
-  } = getDeployURL(opts);
-  console.log('部署网址:', chalk.green(deployedURL));
+  for (const target of opts.targets) {
+    const {
+      deployedURL
+    } = getDeployURL(target);
+    console.log('部署网址:', chalk.green(deployedURL));
+  }
 }
-
 function sshSftpShowConfig(opts) {
   opts = parseOpts(opts);
   console.log(JSON.stringify(opts, null, 2));
@@ -481,7 +461,6 @@ function sshSftpShowConfig(opts) {
     i: true
   });
 }
-
 module.exports = sshSftp;
 module.exports.sshSftp = sshSftp;
 module.exports.sshSftpLS = sshSftpLS;

package/lib/utils.js

@@ -1,40 +1,32 @@
 "use strict";
 
 const chalk = require('chalk');
+
 /**
  * @param {string} message
  * @return {never}
  */
-
-
 function exitWithError(message) {
   console.log(`${chalk.bgRed.white.bold(' ERROR ')} ${chalk.redBright(message)}`);
   process.exit();
 }
-
 function warn(message) {
   if (process.env.__SFTP_NO_WARN) return;
   console.log(`${chalk.bgYellow.white.bold(' WARN ')} ${chalk.yellow.bold(message)}`);
 }
-
 function splitOnFirst(string, separator) {
   if (!(typeof string === 'string' && typeof separator === 'string')) {
     throw new TypeError('Expected the arguments to be of type `string`');
   }
-
   if (string === '' || separator === '') {
     return [];
   }
-
   const separatorIndex = string.indexOf(separator);
-
   if (separatorIndex === -1) {
     return [];
   }
-
   return [string.slice(0, separatorIndex), string.slice(separatorIndex + separator.length)];
 }
-
 module.exports.splitOnFirst = splitOnFirst;
 module.exports.exitWithError = exitWithError;
 module.exports.warn = warn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qse/ssh-sftp",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "教育代码部署工具",
   "main": "lib/index.js",
   "author": "Ironkinoko <kinoko_main@outlook.com>",
@@ -8,7 +8,7 @@
   "scripts": {
     "start": "dumi dev",
     "docs:build": "dumi build && cp sftprc.schema.json docs-dist",
-    "docs:deploy": "ssh-sftp",
+    "docs:deploy": "node ./src/cli.js",
     "build": "father-build",
     "deploy": "yarn docs:build && yarn docs:deploy && rm -rf docs-dist",
     "release": "yarn build && npm publish && rm -rf lib",