@qse/ssh-sftp 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 IronKinoko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# @qse/ssh-sftp
+
+简单易用的 SFTP 工具，可以上传/忽略/删除远程的文件
+
+## 安装
+
+```bash
+# 全局
+npm i @qse/ssh-sftp -g
+
+# 局部
+npm i @qse/ssh-sftp -D
+```
+
+## 使用
+
+1. 首先初始化一份配置文件
+
+`npx ssh-sftp init`
+
+2. 将生成的`.sftprc.json`文件里的信息填写完整
+
+3. 添加脚本到 `package.json`
+
+```json
+{
+  "scripts": {
+    "deploy": "ssh-sftp"
+  }
+}
+```
+
+**建议在部署前使用`npx ssh-sftp ls`查看哪些文件会被上传或删除**
+
+## 字段说明
+
+### `.sftprc.json`
+
+| 字段名           | 类型                                                 | 描述                                           | 默认值                 |
+| ---------------- | ---------------------------------------------------- | ---------------------------------------------- | ---------------------- |
+| localPath        | `string`                                             |                                                | `'dist'`               |
+| remotePath       | `string`                                             |                                                | -                      |
+| connectOptions   | `ConnectOptions`                                     | 登录信息                                       | -                      |
+| ignore           | `string[]`                                           | 忽略`localPath`中的部分文件，`glob`类型        | `['**/*.LICENSE.txt']` |
+| cleanRemoteFiles | `boolean \| string[]`                                | 清空远程文件夹，或按`glob`匹配清空远程部分文件 | `true`                 |
+| securityLock     | `boolean`                                            | 安全锁，默认开启                               | `true`                 |
+| keepAlive        | `boolean`                                            | 保持连接                                       | `false`                |
+| noWarn           | `boolean`                                            | 禁止提示                                       | `false`                |
+| skipPrompt       | `boolean`                                            | 跳过询问，全部同意                             | `false`                |
+| preset           | `{context: string; folder?: string; server?:string}` | 预设登录项                                     | -                      |
+
+`preset.context` 目前只有三个值 `"qsxxwapdev", "eduwebngv1", "qsxxadminv1"`
+
+`preset.folder` 文件夹名称默认使用项目名称，也可自定义文件夹名称，支持多层文件夹，例如 `parent/child`
+
+`preset.server` 部署服务器地址 `"19", "171"`
+
+### `connectOptions`
+
+| 字段名   | 类型     | 描述 |
+| -------- | -------- | ---- |
+| host     | `string` |      |
+| port     | `number` |      |
+| username | `string` |      |
+| password | `string` |      |
+
+### `securityLock`
+
+**安全锁** 默认开启，会校验项目名称与远程地址是否匹配防止误传，关闭后忽略验证
+
+## Commands
+
+### `ssh-sftp init`
+
+初始化生成配置文件 `.sftprc.json`
+
+### `ssh-sftp ls`
+
+列出所有需要上传/删除/忽略的文件
+
+`ssh-sftp ls -u` 单独列出所有需要上传的文件
+
+`ssh-sftp ls -d` 单独列出所有需要删除的文件
+
+`ssh-sftp ls -i` 单独列出所有忽略的文件

package/lib/cli.js

@@ -0,0 +1,126 @@
+#!/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));
+}

package/lib/index.js

@@ -0,0 +1,491 @@
+"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} */
+
+
+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]
+ * @param {Options} opts
+ */
+
+
+async function sshSftp(opts) {
+  opts = parseOpts(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) {
+      sftp.end();
+    }
+  }
+}
+/**
+ * @param {Options} opts
+ * @param {{d:boolean,u:boolean,i:boolean}} lsOpts
+ */
+
+
+async function sshSftpLS(opts, lsOpts) {
+  opts = parseOpts(opts);
+  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 {
+    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 = 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]
+    };
+    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 配置错误，必须是一个文件夹');
+  }
+
+  if (!opts.remotePath) {
+    exitWithError('remotePath 未配置');
+  }
+
+  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'));
+    }
+  }
+
+  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}`;
+  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);
+    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));
+}
+
+function sshSftpShowConfig(opts) {
+  opts = parseOpts(opts);
+  console.log(JSON.stringify(opts, null, 2));
+  sshSftpShowUrl(opts);
+  sshSftpLS(opts, {
+    u: true,
+    d: true,
+    i: true
+  });
+}
+
+module.exports = sshSftp;
+module.exports.sshSftp = sshSftp;
+module.exports.sshSftpLS = sshSftpLS;
+module.exports.sshSftpShowUrl = sshSftpShowUrl;
+module.exports.sshSftpShowConfig = sshSftpShowConfig;
+module.exports.parseOpts = parseOpts;
+module.exports.Client = Client;

package/lib/presets.js

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

package/lib/utils.js

@@ -0,0 +1,40 @@
+"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

@@ -0,0 +1,46 @@
+{
+  "name": "@qse/ssh-sftp",
+  "version": "1.0.0",
+  "description": "教育代码部署工具",
+  "main": "lib/index.js",
+  "author": "Ironkinoko <kinoko_main@outlook.com>",
+  "license": "MIT",
+  "scripts": {
+    "start": "dumi dev",
+    "docs:build": "dumi build && cp sftprc.schema.json docs-dist",
+    "docs:deploy": "ssh-sftp",
+    "build": "father-build",
+    "deploy": "yarn docs:build && yarn docs:deploy && rm -rf docs-dist",
+    "release": "yarn build && npm publish && rm -rf lib",
+    "prettier": "prettier -c -w \"src/**/*.{js,jsx,tsx,ts,less,md,json}\"",
+    "postversion": "npm run release"
+  },
+  "bin": {
+    "ssh-sftp": "lib/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"
+  },
+  "devDependencies": {
+    "dumi": "^1.1.42",
+    "father-build": "^1.22.3"
+  }
+}