@qse/ssh-sftp 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 更新日志
 
+## 1.3.0 (2026-03-04)
+
+- feat: 优化上传速度
+
 ## 1.0.1 (2023-12-15)
 
 - fix: 延长 timeout 时间

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import config from '@qse/eslint-config'
+
+export default config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qse/ssh-sftp",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "教育代码部署工具",
   "main": "src/index.js",
   "author": "Ironkinoko <kinoko_main@outlook.com>",
@@ -10,7 +10,7 @@
     "docs:build": "mkdir -p docs-dist && cp sftprc.schema.json docs-dist",
     "docs:deploy": "node ./src/cli.js",
     "deploy": "npm run docs:build && npm run docs:deploy && rm -rf docs-dist",
-    "release": "npm publish &&",
+    "release": "npm publish",
     "prettier": "prettier -c -w \"src/**/*.{js,jsx,tsx,ts,less,md,json}\"",
     "postversion": "npm run release"
   },
@@ -31,9 +31,12 @@
     "inquirer": "^13.1.0",
     "minimatch": "^10.1.1",
     "ora": "^9.0.0",
+    "p-limit": "^7.3.0",
     "ssh2-sftp-client": "^12.0.1",
-    "update-notifier": "^7.3.1",
     "yargs": "^18.0.0"
   },
-  "devDependencies": {}
+  "devDependencies": {
+    "eslint": "^9.39.3",
+    "@qse/eslint-config": "^1.0.0"
+  }
 }

package/src/cli.js

@@ -4,21 +4,13 @@ import { sshSftp, sshSftpLS, sshSftpShowUrl, sshSftpShowConfig } from './index.j
 import fs from 'fs'
 import ora from 'ora'
 import { exitWithError } from './utils.js'
-import updateNotifier from 'update-notifier'
 import { presets } from './presets.js'
 import Yargs from 'yargs'
 
-const pkg = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url), 'utf-8'))
-
-updateNotifier({
-  pkg,
-  updateCheckInterval: 1000 * 60 * 60 * 24 * 7,
-  shouldNotifyInNpmScript: true,
-}).notify()
-
+// eslint-disable-next-line no-unused-expressions
 Yargs(process.argv.slice(2))
   .usage(
-    '使用: $0 [command] \n\n代码：svn://192.168.10.168/edu/code/A0.New-system/0A2.front-end-component/ssh-sftp/trunk'
+    '使用: $0 [command] \n\n代码：svn://192.168.10.168/edu/code/A0.New-system/0A2.front-end-component/ssh-sftp/trunk',
   )
   .command(
     '*',
@@ -29,7 +21,7 @@ Yargs(process.argv.slice(2))
         desc: '不存在的目录不再询问，直接创建',
         type: 'boolean',
       }),
-    upload
+    upload,
   )
   .command('init', '生成 .sftprc.json 配置文件', {}, generateDefaultConfigJSON)
   .command(
@@ -40,7 +32,7 @@ Yargs(process.argv.slice(2))
         .option('u', { desc: '列出需要上传的文件' })
         .option('d', { desc: '列出需要删除的文件' })
         .option('i', { desc: '列出忽略的文件' }),
-    ls
+    ls,
   )
   .command(['show-config', 'sc'], '显示部署的完整信息', {}, showConfig)
   .command(['show-presets', 'sp'], '显示预设配置', {}, showPresets)
@@ -97,9 +89,9 @@ function generateDefaultConfigJSON() {
         cleanRemoteFiles: false,
       },
       null,
-      2
+      2,
     ),
-    { encoding: 'utf-8' }
+    { encoding: 'utf-8' },
   )
   ora().succeed('.sftprc.json 生成在项目根目录')
 }

package/src/index.js

@@ -4,10 +4,13 @@ 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 { exitWithError, injectTiming, warn } from './utils.js'
 import chalk from 'chalk'
 import { presets, servers } from './presets.js'
 import path from 'path'
+import pLimit from 'p-limit'
+
+const limit = pLimit(6)
 
 /** @type {Options} */
 const defualtOpts = {
@@ -52,30 +55,40 @@ function getFilesPath(localPath, remotePath, ignore) {
  */
 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 })
+  const data = []
+  const queue = [remotePath]
+  const LIST_CONCURRENCY = 6
+
+  while (queue.length > 0) {
+    const batch = queue.splice(0, LIST_CONCURRENCY)
+    const results = await Promise.all(
+      batch.map(async (base) => {
+        try {
+          return { base, list: await sftp.list(base) }
+        } catch {
+          return { base, list: [] }
+        }
+      }),
+    )
+
+    for (const { base, list } of results) {
+      for (const item of list) {
+        const p = `${base}/${item.name}`
+        if (item.type === 'd') {
+          data.push({ isDir: true, path: p })
+          queue.push(p)
+        } else {
+          data.push({ isDir: false, path: p })
+        }
       }
     }
-    return data
   }
-  const ls = (await getFiles(remotePath)).filter((o) => o.path)
+
+  const ls = data.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.filter((o) => safePatterns.some((reg) => minimatch(o.path, reg)))
   }
   return ls
 }
@@ -121,9 +134,8 @@ async function _sshSftp(opts) {
   const { deployedURL, sftpURL } = getDeployURL(opts)
 
   console.log('部署网址:', chalk.green(deployedURL))
-  const spinner = ora(`连接服务器 ${sftpURL}`).start()
+  const spinner = injectTiming(ora(`连接服务器 ${sftpURL}`)).start()
   const sftp = new Client()
-
   try {
     await sftp.connect(opts.connectOptions)
     spinner.succeed(`已连接 ${sftpURL}`)
@@ -205,12 +217,19 @@ async function _sshSftp(opts) {
       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)
-        }
+        await Promise.all(
+          remoteDeletefiles.map((o, i) =>
+            limit(async () => {
+              spinner.text = `[${i + 1}/${remoteDeletefiles.length}] 正在删除 ${o.path}`
+              try {
+                if (o.isDir) await sftp.rmdir(o.path, true)
+                else await sftp.delete(o.path)
+              } catch (e) {
+                console.error(`删除失败: ${o.path}`, e.message)
+              }
+            }),
+          ),
+        )
         spinner.succeed(`已删除 ${opts.remotePath}`)
       }
     }
@@ -218,17 +237,31 @@ async function _sshSftp(opts) {
     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)
-      }
+      const dirs = localUploadFiles.filter((o) => fs.statSync(o.localPath).isDirectory())
+      const files = localUploadFiles.filter((o) => !fs.statSync(o.localPath).isDirectory())
+
+      // 先并发创建目录
+      await Promise.all(
+        dirs.map((o) =>
+          limit(async () => {
+            try {
+              if (!(await sftp.exists(o.remotePath))) {
+                await sftp.mkdir(o.remotePath)
+              }
+            } catch {}
+          }),
+        ),
+      )
+
+      // 再并发上传文件
+      await Promise.all(
+        files.map((o, i) =>
+          limit(async () => {
+            spinner.text = `[${i + 1}/${files.length}] 正在上传 ${o.localPath} 到 ${o.remotePath}`
+            await sftp.fastPut(o.localPath, o.remotePath)
+          }),
+        ),
+      )
     } else {
       await sftp.uploadDir(opts.localPath, opts.remotePath)
     }
@@ -281,7 +314,7 @@ async function _sshSftpLS(opts, lsOpts) {
     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))
+        getSafePattern(opts.ignore, opts.localPath).some((reg) => minimatch(s, reg)),
       )
 
       console.log(`忽略文件 (${ls.length}):`)
@@ -325,7 +358,7 @@ function mergeDelete(files) {
  */
 function getSafePattern(patterns, prefixPath) {
   const safePatterns = patterns
-    .map((s) => s.replace(/^[\.\/]*/, prefixPath + '/'))
+    .map((s) => s.replace(/^[./]*/, prefixPath + '/'))
     .reduce((acc, s) => [...acc, s, s + '/**/*'], [])
   return safePatterns
 }
@@ -407,7 +440,7 @@ function parseOpts(opts) {
             `remotePath：${target.remotePath}`,
             `项目名称：${pkg.name} // 源自 package.json 中的 name 字段，忽略scope字段`,
             `\n你可以设置 "securityLock": false 来关闭这个验证`,
-          ].join('\n')
+          ].join('\n'),
         )
       }
     }

package/src/utils.js

@@ -32,4 +32,26 @@ function splitOnFirst(string, separator) {
   return [string.slice(0, separatorIndex), string.slice(separatorIndex + separator.length)]
 }
 
-export { splitOnFirst, exitWithError, warn }
+/**
+ *
+ * @param {import('ora').Ora} ora
+ */
+function injectTiming(ora) {
+  const oldStart = ora.start
+
+  let current = 0
+  ora.start = (message) => {
+    current = performance.now()
+    return oldStart.call(ora, message)
+  }
+  const oldSucceed = ora.succeed
+  ora.succeed = (message) => {
+    const now = performance.now()
+    const diff = (now - current) / 1000
+    return oldSucceed.call(ora, `${message} ${chalk.dim(`(${diff.toFixed(2)}s)`)}`)
+  }
+
+  return ora
+}
+
+export { splitOnFirst, exitWithError, warn, injectTiming }