@qse/ssh-sftp 1.0.1 → 1.2.0

package/src/index.js

@@ -0,0 +1,471 @@
+import Client from 'ssh2-sftp-client'
+import ora from 'ora'
+import * as glob from 'glob'
+import fs from 'fs'
+import * as minimatch from 'minimatch'
+import inquirer from 'inquirer'
+import { exitWithError, warn } from './utils.js'
+import chalk from 'chalk'
+import { presets, servers } from './presets.js'
+import path from 'path'
+
+/** @type {Options} */
+const defualtOpts = {
+  localPath: 'dist',
+  noWarn: false,
+  keepAlive: false,
+  cleanRemoteFiles: true,
+  ignore: ['**/*.LICENSE.txt'],
+  securityLock: true,
+}
+
+/**
+ * get upload files
+ *
+ * @param {string} localPath
+ * @param {string} remotePath
+ * @param {string[]} ignore
+ */
+function getFilesPath(localPath, remotePath, ignore) {
+  const files = glob.sync(`${localPath}/**/*`, {
+    ignore: getSafePattern(ignore, localPath),
+    dot: true,
+  })
+  return files.map((localFilePath) => {
+    return {
+      localPath: localFilePath,
+      remotePath: localFilePath.replace(localPath, remotePath),
+    }
+  })
+}
+
+/**
+ * get remote ls deep
+ *
+ * @typedef {Object} FilesOptions
+ * @property {true|string[]} [patterns]
+ *
+ * @param {Client} sftp
+ * @param {string} remotePath
+ * @param {FilesOptions} [options]
+ * @return {Promise<{isDir:boolean;path:string}[]>}
+ */
+async function getRemoteDeepFiles(sftp, remotePath, options) {
+  const { patterns } = 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, path })
+        await getFiles(path, data)
+      } else {
+        data.push({ isDir: false, path })
+      }
+    }
+    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, isSame }
+  })
+}
+
+/**
+ * @typedef {Object} Options
+ * @property {string} [localPath]
+ * @property {string} [remotePath]
+ * @property {{context?:string;folder?:string;server?:string}} [preset]
+ * @property {import('ssh2').ConnectConfig} [connectOptions]
+ * @property {string[]} [ignore]
+ * @property {boolean|string[]} [cleanRemoteFiles]
+ * @property {boolean} [securityLock]
+ * @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 } = getDeployURL(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 {
+        const ans = await inquirer.prompt({
+          name: 'confirm',
+          message: `远程文件夹不存在，是否要创建一个`,
+          type: 'confirm',
+        })
+        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,
+      })
+
+      spinner.succeed(`远程文件数量：${remoteDeletefiles.length}`)
+
+      const Confirm = {
+        delete: Symbol(),
+        skip: Symbol(),
+        stop: Symbol(),
+        showDeleteFile: Symbol(),
+      }
+      let confirm = Confirm.delete
+      if (remoteDeletefiles.length > localUploadFiles.length && !opts.skipPrompt) {
+        const showSelect = async () => {
+          const { confirm } = await inquirer.prompt({
+            name: 'confirm',
+            message: `远程需要删除的文件数(${remoteDeletefiles.length})比本地(${localUploadFiles.length})多，确定要删除吗?`,
+            type: 'list',
+            choices: [
+              { name: '删除', value: Confirm.delete },
+              { name: '不删除，继续部署', value: Confirm.skip },
+              { name: '中止部署', value: Confirm.stop },
+              { name: '显示需要删除的文件', value: Confirm.showDeleteFile },
+            ],
+          })
+          return confirm
+        }
+
+        do {
+          confirm = await showSelect()
+          if (confirm === Confirm.stop) {
+            process.exit()
+          }
+          if (confirm === Confirm.showDeleteFile) {
+            const diffFiles = ensureDiff(localUploadFiles, remoteDeletefiles)
+
+            diffFiles.forEach((o) => {
+              const path = o.isSame ? o.path : chalk.red(o.path)
+              console.log(`  - ${path}`)
+            })
+          }
+        } 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, opts }
+  } catch (error) {
+    spinner.fail('异常中断')
+    if (error.message.includes('sftpConnect')) {
+      exitWithError(`登录失败，请检查 connectOptions 配置项\n原始信息：${error.message}`)
+    } else {
+      console.error(error)
+    }
+  } finally {
+    if (!opts.keepAlive) {
+      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}`)
+        }
+      } else {
+        console.log(`上传 ${opts.localPath} 全部文件到 ${opts.remotePath}`)
+      }
+    }
+  } catch (error) {
+    console.error(error)
+  } finally {
+    await sftp.end()
+  }
+}
+
+/**
+ * @param {{isDir:boolean;path:string}[]} files
+ */
+function mergeDelete(files) {
+  let dirs = files.filter((o) => o.isDir)
+  dirs.forEach(({ path }) => {
+    files = files.filter((o) => !(o.path.startsWith(path) && path !== o.path))
+  })
+  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 = JSON.parse(fs.readFileSync(path.resolve('package.json'), 'utf-8'))
+  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] }
+    opts.connectOptions = server
+  }
+  if (opts.preset && opts.preset.context) {
+    if (!presets[opts.preset.context]) exitWithError('未知的 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 配置错误，必须是一个文件夹')
+  }
+
+  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 {
+    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(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 (!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)
+
+  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))
+
+  sshSftpShowUrl(opts)
+  sshSftpLS(opts, { u: true, d: true, i: true })
+}
+
+export default sshSftp
+export { sshSftp, sshSftpLS, sshSftpShowUrl, sshSftpShowConfig, parseOpts, Client }

package/{lib → src}/presets.js

@@ -1,34 +1,31 @@
-"use strict";
-
 const servers = {
   19: {
     host: '192.168.10.19',
     port: 22,
     username: 'root',
-    password: 'eduweb19@'
+    password: 'eduweb19@',
   },
   171: {
     host: '192.168.10.171',
     port: 22,
     username: 'root',
-    password: 'qsweb1@'
-  }
-};
+    password: 'qsweb1@',
+  },
+}
+
 const presets = {
   qsxxwapdev: {
     remotePath: '/erp/edumaven/edu-page-v1',
-    connectOptions: servers[19]
+    connectOptions: servers[19],
   },
   eduwebngv1: {
     remotePath: '/erp/edumaven/edu-web-page-v1',
-    connectOptions: servers[19]
+    connectOptions: servers[19],
   },
   qsxxadminv1: {
     remotePath: '/erp/edumaven/edu-admin-page-dev',
-    connectOptions: servers[19]
-  }
-};
-module.exports = {
-  presets,
-  servers
-};
+    connectOptions: servers[19],
+  },
+}
+
+export { presets, servers }

package/{lib → src}/utils.js

@@ -1,40 +1,35 @@
-"use strict";
+import chalk from 'chalk'
 
-const chalk = require('chalk');
 /**
  * @param {string} message
  * @return {never}
  */
-
-
 function exitWithError(message) {
-  console.log(`${chalk.bgRed.white.bold(' ERROR ')} ${chalk.redBright(message)}`);
-  process.exit();
+  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)}`);
+  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`');
+    throw new TypeError('Expected the arguments to be of type `string`')
   }
 
   if (string === '' || separator === '') {
-    return [];
+    return []
   }
 
-  const separatorIndex = string.indexOf(separator);
+  const separatorIndex = string.indexOf(separator)
 
   if (separatorIndex === -1) {
-    return [];
+    return []
   }
 
-  return [string.slice(0, separatorIndex), string.slice(separatorIndex + separator.length)];
+  return [string.slice(0, separatorIndex), string.slice(separatorIndex + separator.length)]
 }
 
-module.exports.splitOnFirst = splitOnFirst;
-module.exports.exitWithError = exitWithError;
-module.exports.warn = warn;
+export { splitOnFirst, exitWithError, warn }

package/lib/cli.js

@@ -1,126 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-const {
-  sshSftp,
-  sshSftpLS,
-  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,
-  shouldNotifyInNpmScript: true
-}).notify();
-require('yargs').usage('使用: $0 [command] \n\n代码：svn://192.168.10.168/edu/code/A0.New-system/0A2.front-end-component/ssh-sftp/trunk').command('*', '上传文件', yargs => yargs.option('no-clear', {
-  desc: '不删除文件'
-}).option('yes', {
-  alias: 'y',
-  desc: '不存在的目录不再询问，直接创建',
-  type: 'boolean'
-}), upload).command('init', '生成 .sftprc.json 配置文件', {}, generateDefaultConfigJSON).command(['list', 'ls'], '列出所有需要上传/忽略/删除的文件', yargs => yargs.option('u', {
-  desc: '列出需要上传的文件'
-}).option('d', {
-  desc: '列出需要删除的文件'
-}).option('i', {
-  desc: '列出忽略的文件'
-}), ls).command(['show-config', 'sc'], '显示部署的完整信息', {}, showConfig).command(['show-presets', 'sp'], '显示预设配置', {}, showPresets).command(['show-url', 'su'], '显示部署网址', {}, showUrl).alias({
-  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',
-    remotePath: '/path/to/remoteDir',
-    connectOptions: {
-      host: '127.0.0.1',
-      port: 22,
-      username: '',
-      password: ''
-    },
-    ignore: ['**/something[optional].js'],
-    cleanRemoteFiles: false
-  }, null, 2), {
-    encoding: 'utf-8'
-  });
-  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));
-}