@qse/ssh-sftp 1.0.1 → 1.2.0

package/.sftprc.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "sftprc.schema.json",
+  "localPath": "docs-dist",
+  "preset": {
+    "context": "qsxxwapdev",
+    "folder": "edu-ssh-sftp"
+  },
+  "targets": []
+}

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 更新日志
+
+## 1.0.1 (2023-12-15)
+
+- fix: 延长 timeout 时间
+
+## 1.0.0 (2022-09-28)
+
+- feat: 修改包名，初始化版本

package/jsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext"
+  }
+}

package/package.json

@@ -1,46 +1,39 @@
 {
   "name": "@qse/ssh-sftp",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "教育代码部署工具",
-  "main": "lib/index.js",
+  "main": "src/index.js",
   "author": "Ironkinoko <kinoko_main@outlook.com>",
   "license": "MIT",
+  "type": "module",
   "scripts": {
-    "start": "dumi dev",
-    "docs:build": "dumi build && cp sftprc.schema.json docs-dist",
+    "docs:build": "mkdir -p docs-dist && cp sftprc.schema.json docs-dist",
     "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",
+    "deploy": "npm run docs:build && npm run docs:deploy && rm -rf docs-dist",
+    "release": "npm publish &&",
     "prettier": "prettier -c -w \"src/**/*.{js,jsx,tsx,ts,less,md,json}\"",
     "postversion": "npm run release"
   },
   "bin": {
-    "ssh-sftp": "lib/cli.js"
+    "ssh-sftp": "src/cli.js"
   },
   "keywords": [
     "sftp"
   ],
-  "files": [
-    "lib"
-  ],
   "homepage": "http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "dependencies": {
-    "chalk": "^4.1.1",
-    "glob": "^7.1.6",
-    "inquirer": "^8.1.1",
-    "minimatch": "^3.0.4",
-    "ora": "^5.1.0",
-    "ssh2-sftp-client": "^6.0.0",
-    "update-notifier": "^5.1.0",
-    "yargs": "^16.2.0"
+    "chalk": "^5.6.2",
+    "glob": "^13.0.0",
+    "inquirer": "^13.1.0",
+    "minimatch": "^10.1.1",
+    "ora": "^9.0.0",
+    "ssh2-sftp-client": "^12.0.1",
+    "update-notifier": "^7.3.1",
+    "yargs": "^18.0.0"
   },
-  "devDependencies": {
-    "dumi": "^1.1.42",
-    "father-build": "^1.22.3"
-  }
+  "devDependencies": {}
 }

package/sftprc.schema.json

@@ -0,0 +1,192 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "object",
+  "description": "ssh-sftp 配置项",
+  "default": {},
+  "examples": [
+    {
+      "localPath": "/path/to/localDir",
+      "remotePath": "/path/to/remoteDir",
+      "connectOptions": {
+        "host": "127.0.0.1",
+        "port": 22,
+        "username": "",
+        "password": ""
+      },
+      "ignore": ["**/something[optional].js"],
+      "cleanRemoteFiles": false,
+      "securityLock": true,
+      "keepAlive": false,
+      "noWarn": false
+    }
+  ],
+  "required": [],
+  "properties": {
+    "localPath": {
+      "$id": "#/properties/localPath",
+      "type": "string",
+      "description": "本地 dist 地址",
+      "default": "dist",
+      "examples": ["dist"]
+    },
+    "remotePath": {
+      "$id": "#/properties/remotePath",
+      "type": "string",
+      "description": "远程 dist 部署地址",
+      "default": "",
+      "examples": ["/path/to/remoteDir"]
+    },
+    "connectOptions": {
+      "$id": "#/properties/connectOptions",
+      "type": "object",
+      "description": "服务器连接信息",
+      "default": {},
+      "examples": [
+        {
+          "host": "127.0.0.1",
+          "port": 22,
+          "username": "",
+          "password": ""
+        }
+      ],
+      "required": ["host", "port", "username", "password"],
+      "properties": {
+        "host": {
+          "$id": "#/properties/connectOptions/properties/host",
+          "type": "string",
+          "description": "主机",
+          "default": "",
+          "examples": ["127.0.0.1"]
+        },
+        "port": {
+          "$id": "#/properties/connectOptions/properties/port",
+          "type": "integer",
+          "description": "端口号",
+          "default": 0,
+          "examples": [22]
+        },
+        "username": {
+          "$id": "#/properties/connectOptions/properties/username",
+          "type": "string",
+          "description": "用户名",
+          "default": "",
+          "examples": [""]
+        },
+        "password": {
+          "$id": "#/properties/connectOptions/properties/password",
+          "type": "string",
+          "description": "密码",
+          "default": "",
+          "examples": [""]
+        }
+      },
+      "additionalProperties": false
+    },
+    "preset": {
+      "$id": "#/properties/preset",
+      "type": "object",
+      "description": "预设连接配置",
+      "default": {},
+      "examples": [
+        {
+          "context": "qsxxwapdev"
+        }
+      ],
+      "properties": {
+        "context": {
+          "$id": "#/properties/preset/properties/context",
+          "type": "string",
+          "description": "v1部署前缀",
+          "examples": ["qsxxwapdev", "eduwebngv1", "qsxxadminv1"]
+        },
+        "folder": {
+          "$id": "#/properties/preset/properties/folder",
+          "type": "string",
+          "description": "部署文件夹名称，默认使用项目名称"
+        },
+        "server": {
+          "$id": "#/properties/preset/properties/server",
+          "type": "string",
+          "description": "部署的服务器",
+          "examples": ["19", "171"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "ignore": {
+      "$id": "#/properties/ignore",
+      "type": "array",
+      "description": "忽略上传某些文件",
+      "default": [],
+      "examples": [["**/something[optional].js"]],
+      "additionalItems": true,
+      "items": {
+        "$id": "#/properties/ignore/items",
+        "type": "string"
+      }
+    },
+    "cleanRemoteFiles": {
+      "$id": "#/properties/cleanRemoteFiles",
+      "type": ["boolean", "array"],
+      "description": "清空远程数据",
+      "default": false,
+      "examples": [false, ["**/something[optional].js"]],
+      "items": {
+        "$id": "#/properties/cleanRemoteFiles/items",
+        "type": "string"
+      }
+    },
+    "securityLock": {
+      "$id": "#/properties/securityLock",
+      "type": "boolean",
+      "description": "启用安全锁",
+      "default": true,
+      "examples": [true]
+    },
+    "keepAlive": {
+      "$id": "#/properties/keepAlive",
+      "type": "boolean",
+      "description": "上传完毕后保持与连接",
+      "default": false,
+      "examples": [false]
+    },
+    "noWarn": {
+      "$id": "#/properties/noWarn",
+      "type": "boolean",
+      "description": "禁用控制台提示",
+      "default": false,
+      "examples": [false]
+    },
+    "skipPrompt": {
+      "$id": "#/properties/skipPrompt",
+      "type": "boolean",
+      "description": "不存在的目录不再询问，直接创建",
+      "default": false,
+      "examples": [false]
+    },
+    "targets": {
+      "$id": "#/properties/targets",
+      "type": "array",
+      "description": "多目标上传配置",
+      "default": [],
+      "examples": [[{ "remotePath": "/path/to/remoteDir" }]],
+      "items": {
+        "$id": "#/properties/targets/items",
+        "type": "object",
+        "properties": {
+          "remotePath": {
+            "$id": "#/properties/targets/items/properties/remotePath",
+            "$ref": "#/properties/remotePath"
+          },
+          "connectOptions": {
+            "$id": "#/properties/targets/items/properties/connectOptions",
+            "$ref": "#/properties/connectOptions"
+          }
+        },
+        "required": ["remotePath"],
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/src/cli.js

@@ -0,0 +1,125 @@
+#!/usr/bin/env node
+
+import { sshSftp, sshSftpLS, sshSftpShowUrl, sshSftpShowConfig } from './index.js'
+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()
+
+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'
+  )
+  .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))
+}