@dypnb/dev-tools 1.0.11 → 1.0.13

package/src/gen-swagger/index.js

@@ -1,228 +0,0 @@
-#! /usr/bin/env node
-
-// 将swagger 转换为 vue api代码 
-import path  from "path";
-import fs  from "fs";
-import http  from "http";
-import { getGlobalConfig, getDirname, errorLog, log, successLog, } from "../utils/index.js";
-const __dirname = getDirname();
-
-
-async function getSwaggerConfig() {
-  return await getGlobalConfig('swaggerConfig');
-}
-
-getSwaggerConfig().then(res => {
-  // swagger配置
-  const swaggerConfig = res;
-  if (!swaggerConfig) {
-    errorLog('swaggerConfig 未配置')
-  }
-
-  // 生成api文件地址
-  const srcFolder = `${process.env.PWD}${swaggerConfig.outputDir}`;
-  // swagger接口地址
-  const url = `${swaggerConfig.path}${swaggerConfig.staticPath}`;
-
-  genSwagger(srcFolder, url);
-  
-})
-
-
-// 生成本地文件
-function mkdirsSync(dirname) {
-  if (fs.existsSync(dirname)) {
-    return true;
-  } else {
-    if (mkdirsSync(path.dirname(dirname))) {
-      fs.mkdirSync(dirname);
-      return true;
-    }
-  }
-}
-
-function getPath(pathUrl) {
-  return path.resolve(__dirname, pathUrl);
-}
-
-function generateTemplate(arr) {
-  return `import request from '@/utils/request'\n`;
-}
-
-// 下划线转换驼峰
-function toHump(name) {
-  return name.replace(/\/(\w)/g, function (all, letter) {
-    return letter.toUpperCase();
-  });
-}
-
-// 短横线转换驼峰
-function shortToHump(name) {
-  return name.replace(/-(\w)/g, function (all, letter) {
-    return letter.toUpperCase();
-  });
-}
-
-// 去除花括号，获取干净的字段
-function removeBrace(value) {
-  const regex = /\{(.+?)\}/g; // {} 花括号，大括号
-  const str = value.match(regex)[0] || "";
-  return str.replace(/\{|}/g, "");
-}
-
-/**
- * 生成具体的api: 
- * export function postRsArticle(data) {
- *  return request({
- *   url: '/rs/article',
- *    method: 'post', 
- *    data: data
- *  })
- * }
- */
-function generateFunc(url, summary, type = "post") {
-  // 去除 url 环境前缀： /dev-risk-api/sc/apply/{applyId} ==> /sc/apply/{applyId}
-  // url = url.split('/');
-  // url.splice(1,1)
-  // url = url.join('/');
-
-  const isBrace = url.indexOf("{") !== -1;
-  let funcName = shortToHump(toHump(type + url));
-  let splitUrl = "";
-  let braceKey = "";
-  if (isBrace) {
-    splitUrl = url.split("{")[0];
-    braceKey = removeBrace(url);
-    funcName = shortToHump(toHump(type + splitUrl + braceKey));
-  }
-
-  const funcArguments = `${
-    isBrace
-      ? braceKey
-      : !isBrace && (type === "post" || type === "put")
-      ? "data"
-      : "query"
-  }`;
-  const funcUrl = `${!isBrace ? `'${url}'` : `'${splitUrl}' + ${braceKey}`}`;
-  const funcParams = `${
-    isBrace
-      ? ""
-      : !isBrace && (type === "post" || type === "put")
-      ? "\n    data: data"
-      : "\n    params: query"
-  }`;
-
-  return `
-// ${summary || ""}
-export function ${funcName}(${funcArguments}) {
-  return request({
-    url: ${funcUrl},
-    method: '${type}', ${funcParams}
-  })
-}\n`;
-}
-
-function httpgetJson(url) {
-  return new Promise((resolve, reject) => {
-    http
-      .get(url, (res) => {
-        const { statusCode } = res;
-        const contentType = res.headers["content-type"];
-
-        let error;
-        if (statusCode !== 200) {
-          error = new Error("请求失败。\n" + `状态码: ${statusCode}`);
-        } else if (!/^application\/json/.test(contentType)) {
-          error = new Error(
-            "无效的 content-type.\n" +
-              `期望 application/json 但获取的是 ${contentType}`
-          );
-        }
-        if (error) {
-          errorLog(error.message);
-          // 消耗响应数据以释放内存
-          res.resume();
-          return;
-        }
-
-        res.setEncoding("utf8");
-        let rawData = "";
-        res.on("data", (chunk) => {
-          rawData += chunk;
-        });
-        res.on("end", () => {
-          try {
-            const parsedData = JSON.parse(rawData);
-            resolve(parsedData);
-          } catch (e) {
-            reject(`错误: ${e.message}`);
-          }
-        });
-      })
-      .on("error", (e) => {
-        reject(`错误: ${e.message}`);
-      });
-  });
-}
-
-async function genSwagger(srcFolder, url) {
-  log("获取远程json文件中...");
-  const { paths } = await httpgetJson(url);
-  successLog("获取成功正在生成api文件");
-  const obj = {};
-  /**
-   * 将数据转换成格式
-   * se-ex-exam-controller: [
-   *   {
-   *     folder:'exam'
-   *     name:'/ex/exam'
-   *     summary:'修改考试考卷'
-   *     tag:'se-ex-exam-controller'
-   *     type:'put'
-   *   }
-   *   ...
-   * ]
-   */
-  for (const name in paths) {
-    const path = paths[name] || {};
-    const pathKeys = Object.keys(path) || [];
-    for (let i = 0, len = pathKeys.length; i < len; i++) {
-      const apiType = pathKeys[i];
-      const tag = path[apiType].tags[0];
-      if (!tag) continue;
-      log(tag);
-      const urlArray = name.slice(1).split("/");
-      const folder = urlArray[1];
-      const item = {
-        summary: path[apiType].summary,
-        tag,
-        name,
-        type: apiType,
-        folder,
-      };
-      if (obj[path[apiType].tags[0]]) {
-        obj[path[apiType].tags[0]].push(item);
-      } else {
-        obj[path[apiType].tags[0]] = [item];
-      }
-    }
-  }
-  for (const tagName in obj) {
-    let jsString = "";
-    const requestTypes = [];
-    let folder = "";
-    for (const item of obj[tagName]) {
-      const requestType = requestTypes.filter((o) => o === item.type);
-      if (requestType.length === 0) requestTypes.push(item.type);
-      jsString += generateFunc(item.name, item.summary, item.type);
-      folder = item.folder;
-    }
-    jsString = generateTemplate(requestTypes) + jsString;
-    mkdirsSync(getPath(`${srcFolder}/${folder}`));
-    // console.log(jsString)
-    fs.writeFileSync(getPath(`${srcFolder}/${folder}/${tagName}.js`), jsString);
-  }
-  successLog("生成完毕");
-}
-
-

package/src/index.js

@@ -1,12 +0,0 @@
-const genPage = require("./gen-page");
-const genSwagger = require("./gen-swagger");
-const publishServer = require("./publish-server");
-const wxServerNotice = require("./wx-server-notice");
-
-
-module.exports =  {
-  genPage,
-  genSwagger,
-  publishServer,
-  wxServerNotice
-}

package/src/publish-server/index.js

@@ -1,130 +0,0 @@
-#! /usr/bin/env node
-
-// scp2 : https://www.npmjs.com/package/
-// 引入scp2
-import client from "scp2";
-import ora from "ora";
-import moment from "moment";
-import { getGlobalConfig, getGitInfo, errorLog, magentaLog, log, warningLog, successLog, cyanLog } from "../utils/index.js";
-import { wxNotify } from "../wx-server-notice/index.js";
-import pkg from 'ssh2';
-const { Client } = pkg;
-
-moment.locale('zh-cn'); 
-
-async function getUploadServeConfig() {
-  return await getGlobalConfig();
-}
-
-getUploadServeConfig().then(res => {
-  const uploadServeConfig = res['uploadServeConfig'];
-  const wxServerConfig = res['wxServerConfig'];
-
-  const isProduction = process.env.VUE_APP_PACK_ENV === "pro"; // 是否是生产环境
-
-  const lineVersion = process.env.VUE_APP_LINE_VERSION; //线上环境版本（多个显示环境可使用此字段区分）
-
-  const isNewPro = isProduction && +lineVersion === 2; // 是否是新的线上版本
-
-  const host = !isNewPro ? uploadServeConfig.host[0] : uploadServeConfig.host[1]; 
-
-  const staticPath = !isProduction ? uploadServeConfig.staticPath.dev : uploadServeConfig.staticPath.pro;
-
-  const onlinePath = `${uploadServeConfig.protocol}://${host}/${staticPath}`
-
-  const gitInfo = getGitInfo();
-
-  const server = {
-    host, // 服务器ip
-    port: "22", // 端口一般默认22
-    locaPath: `${process.env.PWD}${uploadServeConfig.locaPath}`, // 本地打包文件的位置
-    ...uploadServeConfig.serverOption,
-    pathNmae: `${uploadServeConfig.serverOption.pathNmae}${staticPath}` // 上传到服务器的位置
-  };
-
-  const packInfo =  {
-    ...(uploadServeConfig.baseInfo || {}),
-    serverPath: server.pathNmae
-  }
-
-
-  function wxMsg(status) {
-    return `<div class="gray">${moment().format('lll')}</div><div class="highlight">${uploadServeConfig.projectTitle}${isProduction ? "生产" : "开发"}环境发布${status}</div><div class="normal">commitId：${gitInfo.commitId}</div><div class="normal">commitMsg：${gitInfo.commitMsg}</div><div class="normal">访问地址：${onlinePath}</div>`
-  }
-
-
-  cyanLog("本次打包信息 =>", packInfo);
-
-
-
-  const spinner = ora(
-    "正在发布到" + (isProduction ? "生产" : "开发") + "服务器..."
-  );
-  
-  // 创建shell脚本
-  const conn = new Client();
-
-  magentaLog("正在建立连接");
-
-  conn
-    .on("ready", function() {
-      log("已连接");
-      if (!server.pathNmae) {
-        log("连接已关闭");
-        conn.end();
-        return false;
-      }
-      // 这里我拼接了放置服务器资源目录的位置 ，首选通过rm -rf删除了这个目录下的文件
-      conn.exec("rm -rf " + server.pathNmae + "/*", function(err, stream) {
-        warningLog("已删除服务端文件")
-        stream.on("close", function(code, signal) {
-          log("开始上传");
-          spinner.start();
-          client.scp(
-            server.locaPath,
-            {
-              host: server.host,
-              port: server.port,
-              username: server.username,
-              password: server.password,
-              path: server.pathNmae
-            },
-            err => {
-              spinner.stop();
-              if (!err) {
-                successLog("Success! 成功发布到" + (isProduction ? "生产" : "开发") + "服务器!", `访问地址====>${onlinePath}`)
-                wxNotify({
-                  msgtype: "textcard",
-                  textcard: {
-                    title: "发布成功",
-                    description: wxMsg('成功'),
-                    url: onlinePath,
-                    btntxt: "更多"
-                  }
-                }, wxServerConfig);
-              } else {
-                errorLog("发布失败.\n", err);
-                wxNotify({
-                  msgtype: "textcard",
-                  textcard: {
-                    title: "发布失败",
-                    description: wxMsg('失败'),
-                    url: onlinePath,
-                    btntxt: "更多"
-                  }
-                }, wxServerConfig);
-              }
-              conn.end(); // 结束命令
-            }
-          );
-        });
-      });
-    })
-    .connect({
-      host: server.host,
-      port: server.port,
-      username: server.username,
-      password: server.password
-      //privateKey: '' //使用 私钥密钥登录 目前测试服务器不需要用到
-    });
-})

package/src/publish-server/index.mjs

@@ -1,130 +0,0 @@
-#! /usr/bin/env node
-
-// scp2 : https://www.npmjs.com/package/
-// 引入scp2
-import client from "scp2";
-import ora from "ora";
-import moment from "moment";
-import { getGlobalConfig, getGitInfo, errorLog, magentaLog, log, warningLog, successLog, cyanLog } from "../utils/index.js";
-import { wxNotify } from "../wx-server-notice/index.js";
-import pkg from 'ssh2';
-const { Client } = pkg;
-
-moment.locale('zh-cn'); 
-
-async function getUploadServeConfig() {
-  return await getGlobalConfig();
-}
-
-getUploadServeConfig().then(res => {
-  const uploadServeConfig = res['uploadServeConfig'];
-  const wxServerConfig = res['wxServerConfig'];
-
-  const isProduction = process.env.VUE_APP_PACK_ENV === "pro"; // 是否是生产环境
-
-  const lineVersion = process.env.VUE_APP_LINE_VERSION; //线上环境版本（多个显示环境可使用此字段区分）
-
-  const isNewPro = isProduction && +lineVersion === 2; // 是否是新的线上版本
-
-  const host = !isNewPro ? uploadServeConfig.host[0] : uploadServeConfig.host[1]; 
-
-  const staticPath = !isProduction ? uploadServeConfig.staticPath.dev : uploadServeConfig.staticPath.pro;
-
-  const onlinePath = `${uploadServeConfig.protocol}://${host}/${staticPath}`
-
-  const gitInfo = getGitInfo();
-
-  const server = {
-    host, // 服务器ip
-    port: "22", // 端口一般默认22
-    locaPath: `${process.env.PWD}${uploadServeConfig.locaPath}`, // 本地打包文件的位置
-    ...uploadServeConfig.serverOption,
-    pathNmae: `${uploadServeConfig.serverOption.pathNmae}${staticPath}` // 上传到服务器的位置
-  };
-
-  const packInfo =  {
-    ...(uploadServeConfig.baseInfo || {}),
-    serverPath: server.pathNmae
-  }
-
-
-  function wxMsg(status) {
-    return `<div class="gray">${moment().format('lll')}</div><div class="highlight">${uploadServeConfig.projectTitle}${isProduction ? "生产" : "开发"}环境发布${status}</div><div class="normal">commitId：${gitInfo.commitId}</div><div class="normal">commitMsg：${gitInfo.commitMsg}</div><div class="normal">访问地址：${onlinePath}</div>`
-  }
-
-
-  cyanLog("本次打包信息 =>", packInfo);
-
-
-
-  const spinner = ora(
-    "正在发布到" + (isProduction ? "生产" : "开发") + "服务器..."
-  );
-  
-  // 创建shell脚本
-  const conn = new Client();
-
-  magentaLog("正在建立连接");
-
-  conn
-    .on("ready", function() {
-      log("已连接");
-      if (!server.pathNmae) {
-        log("连接已关闭");
-        conn.end();
-        return false;
-      }
-      // 这里我拼接了放置服务器资源目录的位置 ，首选通过rm -rf删除了这个目录下的文件
-      conn.exec("rm -rf " + server.pathNmae + "/*", function(err, stream) {
-        warningLog("已删除服务端文件")
-        stream.on("close", function(code, signal) {
-          log("开始上传");
-          spinner.start();
-          client.scp(
-            server.locaPath,
-            {
-              host: server.host,
-              port: server.port,
-              username: server.username,
-              password: server.password,
-              path: server.pathNmae
-            },
-            err => {
-              spinner.stop();
-              if (!err) {
-                successLog("Success! 成功发布到" + (isProduction ? "生产" : "开发") + "服务器!", `访问地址====>${onlinePath}`)
-                wxNotify({
-                  msgtype: "textcard",
-                  textcard: {
-                    title: "发布成功",
-                    description: wxMsg('成功'),
-                    url: onlinePath,
-                    btntxt: "更多"
-                  }
-                }, wxServerConfig);
-              } else {
-                errorLog("发布失败.\n", err);
-                wxNotify({
-                  msgtype: "textcard",
-                  textcard: {
-                    title: "发布失败",
-                    description: wxMsg('失败'),
-                    url: onlinePath,
-                    btntxt: "更多"
-                  }
-                }, wxServerConfig);
-              }
-              conn.end(); // 结束命令
-            }
-          );
-        });
-      });
-    })
-    .connect({
-      host: server.host,
-      port: server.port,
-      username: server.username,
-      password: server.password
-      //privateKey: '' //使用 私钥密钥登录 目前测试服务器不需要用到
-    });
-})

package/src/utils/index.js

@@ -1,82 +0,0 @@
-import findup  from "findup-sync";
-import chalk  from "chalk";
-import execa  from "execa";
-
-// 最新 node 核心包的导入写法
-import { fileURLToPath } from "node:url";
-import { dirname } from "node:path";
-
-
-export async function getGlobalConfig(type) {
-  const name = findup("dyp.config.js", { cwd: process.env.PWD });
-  const dypConfig = await import(name);
-  if (type) {
-    return dypConfig["default"][type];
-  }
-  return dypConfig["default"];
-}
-
-// 首字母大写
-export function strCase(str) {
-  return str.toLowerCase().replace(/( |^)[a-z]/g, (L) => L.toUpperCase());
-}
-
-// 获取文件名
-export function getFilename() {
-  return fileURLToPath(import.meta.url);
-}
-
-// 获取根路径
-export function getDirname() {
-  return dirname(fileURLToPath(import.meta.url));
-}
-
-export function log(mainMsg, laterMsg) {
-  return chalkLog("blue", mainMsg, laterMsg);
-}
-
-export function cyanLog(mainMsg, laterMsg = "") {
-  return chalkLog("cyan", mainMsg, laterMsg);
-}
-
-export function magentaLog(mainMsg, laterMsg = "") {
-  return chalkLog("magenta", mainMsg, laterMsg);
-}
-
-export function successLog(mainMsg, laterMsg = "") {
-  return chalkLog("green", mainMsg, laterMsg);
-}
-
-export function warningLog(mainMsg, laterMsg = "") {
-  return chalkLog("yellow", mainMsg, laterMsg);
-}
-
-export function errorLog(mainMsg, laterMsg = "") {
-  return chalkLog("red", mainMsg, laterMsg);
-}
-
-export function chalkLog(chalkType, mainMsg, laterMsg = "") {
-  if (!laterMsg) {
-    return console.log(chalk[chalkType](`${mainMsg}`));
-  }
-  return console.log(chalk[chalkType](`${mainMsg}`), laterMsg);
-}
-
-/**
- * 获取最新 commit 提交信息
- * git 获取提交信息参考：https://www.cnblogs.com/ruiy/p/15904295.html
- * @returns {commitId, commitMsg}
- */
-
-export function getGitInfo() {
-  const shortCommid = execa.commandSync("git rev-parse --short HEAD");
-
-  const gitComMsg = `git log --pretty=format:“%s” ${shortCommid.stdout} -1`;
-
-  const { stdout, stderr } = execa.commandSync(gitComMsg);
-
-  return {
-    commitId: shortCommid.stdout,
-    commitMsg: stdout,
-  };
-}

package/src/wx-server-notice/README.md

@@ -1,59 +0,0 @@
-### 需要的变量
-
-```txt
-WX_COMPANY_ID= 企业ID
-WX_APP_ID= 应用ID
-WX_APP_SECRET= 应用 Secret
-
-TIAN_API_KEY= 天行数据 key
-```
-
-<details><summary>点击查看企业微信的注册步骤的详细示例</summary>
-
-#### 第一步，注册企业
-
-用电脑打开[企业微信官网](https://work.weixin.qq.com/)，注册一个企业。有手机号就可以注册，不用营业执照！不用营业执照！不用营业执照！
-
-#### 第二步，创建应用
-
-注册成功后，点「管理企业」进入管理界面，选择「应用管理」 → 「自建」 → 「创建应用」
-
-![创建应用-1](images/qiyewx-2.png)
-
-应用名称随意填，可见范围选择公司名（或指定组织、个人，建议选择全部，然后在代码里指定用户）。
-
-![创建应用-2](images/qiyewx-3.png)
-
-指定成员或组织
-
-![指定范围](images/qiyewx-3-2.png)
-
-创建完成后进入应用详情页，可以得到应用 ID( agentid )①，应用 Secret( secret )②。
-
-![创建应用-3](images/qiyewx-3-1.png)
-
-#### 第三步，获取企业 ID
-
-进入「[我的企业](https://work.weixin.qq.com/wework_admin/frame#profile)」页面，拉到最下边，可以得到企业 ID③。
-
-![企业ID](images/qiyewx-6.png)
-
-#### 第四步，推送消息到微信
-
-进入「我的企业」 → 「[微信插件](https://work.weixin.qq.com/wework_admin/frame#profile/wxPlugin)」，拉到下边扫描二维码，关注以后即可收到推送的消息。
-
-![第四步](images/qiyewx-4.png)
-
-#### 无法接收到消息的异常情况处理
-
-PS：如果出现`接口请求正常，企业微信接受消息正常，个人微信无法收到消息`的情况：
-
-1. 进入「我的企业」 → 「微信插件」，拉到最下方，勾选 “允许成员在微信插件中接收和回复聊天消息”
-
-    ![异常情况-1](images/qiyewx-5.jpg)
-
-2. 在企业微信客户端 「我」 → 「设置」 → 「新消息通知」中关闭 “仅在企业微信中接受消息” 限制条件
-
-    ![异常情况-2](images/qiyewx-5-1.jpg)
-
-</details>

package/src/wx-server-notice/api.js

@@ -1,45 +0,0 @@
-
-
-/**
- * @description 根据企业ID、应用secret 获取token
- * @returns token
- */
-import axios from 'axios';
-const BASE_URL = 'https://qyapi.weixin.qq.com'
-
- // 获取token
- export async function getToken({ id, secret }) {
-   try {
-     const response = await axios({
-       url: `${BASE_URL}/cgi-bin/gettoken?corpid=${id}&corpsecret=${secret}`,
-       method: 'GET',
-       headers: {
-         'Content-Type': 'application/json',
-       },
-     })
-     return response.data.access_token
-   }
-   catch (error) {
-     console.log(error)
-     return ''
-   }
- }
-
- /**
- * 发送消息通知到企业微信
- * 
- * api示列: https://developer.work.weixin.qq.com/tutorial/application-message/3
- * api: https://developer.work.weixin.qq.com/document/path/90372
- */
- export const postMsg = async(accessToken, config) => {
-  const response = await axios({
-    url: `${BASE_URL}/cgi-bin/message/send?access_token=${accessToken}`,
-    method: 'POST',
-    data: {
-      touser: config.touser || '@all',
-      ...config,
-    },
-  })
-  return response.data
-}
-