crabatool 1.0.13 → 1.0.18

package/index.js

@@ -5,37 +5,34 @@ var fs = require('fs');
 var path = require('path');
 var readline = require('readline');
 
-exports = module.exports;
+module.exports.run = function(options) {
+  console.log('当前环境:' + process.platform);
+  console.log('平台助手启动参数:', options);
 
-exports.run = function(options) {
   Object.assign(config, options);
   checkConfig();
   waitInput();
 }
 
 function checkConfig() {
-  console.log('当前环境:' + process.platform);
-  console.log('平台助手启动参数:', config);
-
   if (!config.webPath) {
-    throw new Error('请检查config.js，必须告诉工具当前项目的端路径地址，填绝对路径哦');
+    throw new Error('请检查craba.js，必须告诉工具当前项目的前端路径地址，填绝对路径哦');
   }
   if (!config.port) {
-    throw new Error('请检查config.js，必须告诉工具当前项目前端服务器端口地址哦');
+    throw new Error('请检查craba.js，必须告诉工具当前项目前端服务器端口地址哦');
   }
 
   if (!fs.existsSync(config.webPath)) {
-    throw new Error(`配置的webPath路径不存在，请检查拼写是否正确:${config.webPath}`);;
+    throw new Error(`请检查craba.js，配置的webPath路径不存在，请检查拼写是否正确:${config.webPath}`);;
   }
 
   var crabaJs = path.join(config.webPath, 'js/craba.min.js');
   if (!fs.existsSync(crabaJs)) {
-    throw new Error('平台前端组件不存在，请检查指定的webPath路径是否为craba前端框架的根目录。' + crabaJs);
+    throw new Error('请检查craba.js，平台前端组件不存在，请检查指定的webPath路径是否为craba前端框架的根目录。' + crabaJs);
   }
 
-  var localData = upgrade.getLocalVersion();
+  showLocalVersion();
 
-  console.log(`\r\n\r\n本地craba版本：[${localData.version}]\r\n本地craba日期：[${localData.date}]`);
   console.log("---------------------------------------------------------------------------------------------------------");
 }
 
@@ -56,18 +53,22 @@ function waitInput() {
 
   (async () => {
     var ques = [
-      "1. 启动服务。\t\t\t\t主要包含：自动打包init.js和biz.js，后期还有es6语法兼容等",
-      "2. 更新平台后启动服务。\t\t\t[内网才可用]",
-      "3. 查询最新平台版本和日期。\t\t[内网才可用]",
-      "4. 安装或更新IDEA环境。\t\t\t[内网才可用] 主要包含：智能语法、新增页面模板",
-      "5. 安装或更新vscode环境。\t\t[内网才可用] 主要包含：智能语法、新增页面模板、ctrl+alt+n、alt+j快捷键",
-      "6. 新建Craba空白项目。\t\t\t[内网才可用]",
-      "7. 结束 \t\t\t\t或按Ctrl+C即可退出",
+      "1. 启动服务。\t\t\t\t主要包含：自动合并打包init.js和biz.js，查看本地平台的版本",
+      "2. 更新当前项目的平台，然后启动服务。\t主要包含：从<内网>拉取环境相关资源，再拷贝到webPath路径下覆盖老文件，替代手工操作，同时解决npm不稳定问题",
+      "3. 查询最新平台版本和日期。\t\t主要包含：从<内网>拉取最新平台版本，开发好及时更新补丁",
+      "4. 校验当前项目前端所有js语法兼容性。\t主要包含：对本地js语法做一次初步预检避免上线后才发现问题；比如：编码、let、const、=>、async、await、then、缺function",
+      "5. 打包当前项目前端所有js。\t\t主要包含：前端es6语法的打包和js的统一压缩处理",
+      "6. 安装或更新IDEA环境。\t\t\t主要包含：从<内网>拉取环境相关资源，包括智能语法、新增页面模板、更多新功能",
+      "7. 安装或更新vscode环境。\t\t主要包含：从<内网>拉取环境相关资源，包括智能语法、新增页面模板、ctrl+alt+n、alt+j快捷键",
+      "8. 新建Craba项目。\t\t\t主要包含：从<内网>拉取环境相关资源，根据模板创建新项目，避免手工拷贝文件",
+      "9. 结束 \t\t\t\t按Ctrl+C即可退出",
+      "#. 如果你对[nodejs版本的平台助手]有更多建议或想法可反馈给技术架构组改进哦",
+      "已实现功能：1、2、3、4、8、9",
       "---------------------------------------------------------------------------------------------------------",
       "请输入对应功能的编号（数字）："
     ];
     const num = await question(ques.join('\r\n'));
-    if (num != 6) {
+    if (num != 8) {
       rl.close(); // 关闭输入等待
     }
 
@@ -79,17 +80,43 @@ function waitInput() {
       showNewVersion();
       waitInput(); // 重复
     } else if (num == 4) {
-      installIDEA();
+      checkAllJs();
     } else if (num == 5) {
-      installvscode();
+      compressAllJs();
     } else if (num == 6) {
-      const webFolder = await question('请输入项目路径：');
+      installIDEA();
+    } else if (num == 7) {
+      installvscode();
+    } else if (num == 8) {
+      var options = {};
+      options.projectPath = await waitFolder();
+      options.type = await question('选择项目类型：1. 普通craba项目;  2. ngp微前端项目; 输入编号：');
+      if (options.type != 1 && options.type != 2) options.type = 1;
+      if (options.type == 2) {
+        options.modName = await question('请输入微服务的模块名称：');
+        if (!options.modName) options.modName = 'emptyname';
+      }
       rl.close(); // 关闭输入等待
-      createProject(webFolder);
-    } else if (num != 7) {
+      createProject(options);
+    } else if (num != 9) {
       console.error('无效输入,请继续。\r\n\r\n');
       waitInput(); // 重复
     }
+
+    async function waitFolder() {
+      const projectPath = await question('请输入项目生成路径（必须为空路径）：');
+      if (!path.isAbsolute(projectPath)) {
+        console.log('路径不合法，请输入绝对路径，如:f:\\craba_web');
+        return waitFolder();
+      }
+      if (fs.existsSync(projectPath)) {
+        if (fs.readdirSync(projectPath).length > 0) {
+          console.log(':::输入的项目路径不为空，避免文件覆盖或冲突，请重新输入一个空路径或不存在的路径:::');
+          return waitFolder();
+        }
+      }
+      return projectPath;
+    }
   })();
 }
 
@@ -103,10 +130,18 @@ function update() {
   upgrade.updateCraba(start);
 }
 
+function showLocalVersion() {
+  var localData = upgrade.getLocalVersion();
+  console.log(`\r\n本地craba版本：[${localData.version}]\r\n本地craba日期：[${localData.date}]`);
+}
+
 function showNewVersion() {
+  showLocalVersion();
+
   var data = upgrade.getNewVersion();
-  console.log(`最新平台版本：[${data.version}]`);
-  console.log(`最新平台日期：[${data.date}]\r\n\r\n`);
+  utils.error(`最新craba版本：[${data.version}]`);
+  utils.error(`最新craba日期：[${data.date}]`);
+  utils.log('');
 }
 
 // 安装或更新IDEA环境，主要包含：智能语法、新增页面模板
@@ -119,7 +154,15 @@ function installvscode() {
   console.log('待实现');
 }
 
-// 新建Craba空白项目，Hello
-function createProject(webFolder) {
+function checkAllJs() {
+  require('./tool/checkjs.js').start();
+}
+
+function compressAllJs() {
   console.log('待实现');
+}
+
+// 新建Craba空白项目，Hello
+function createProject(options) {
+  upgrade.createProject(options);
 }

package/lib/config.js

@@ -1,2 +1,19 @@
-exports = module.exports;
-exports = {};
+var path = require('path');
+var os = require('os');
+
+class Config {
+  constructor() {
+    this.Debug = false;
+    this.Host = "http://crabadoc.mygjp.com.cn";
+    this.TempPath = path.join(os.tmpdir(), '_crabatemp');
+    this.ImageCache = path.join(this.TempPath, "_img");
+    this.JsonFile = path.join(this.TempPath, "craba.json");
+    this.SaveFilePath = path.join(this.TempPath, "_CrabaUpdate");
+    this.CachePath = path.join(this.SaveFilePath, "_unzip");
+    this.WebPath = path.join(this.CachePath, "www");
+    this.ServerPath = path.join(this.CachePath, "server");
+    this.CacheFileName = path.join(this.SaveFilePath, "craba.zip");
+  }
+}
+
+module.exports = new Config();

package/lib/server.js

@@ -9,7 +9,13 @@ var compression = require('compression');
 var app = new express();
 app.use(compression()); // 开启压缩
 
-// 自动刷新
+
+// 自定义打包js
+if (config.modName && config.childModList && config.childModList.length > 0) {
+  require('../tool/ngptool.js');
+}
+
+// 自动刷新浏览器
 if (config.refresh) {
   utils.log('已开启自动刷新');
 
@@ -17,7 +23,7 @@ if (config.refresh) {
     config.socketPort = config.port + 6000;
   }
 
-  require('./sockettool.js');
+  require('../tool/sockettool.js');
 
   // 统一拦截客户端的api路由
   app.use(utils.rewriteCrabaJs);
@@ -25,7 +31,6 @@ if (config.refresh) {
 
 app.use(express.static(config.webPath))
 
-
 var server = http.createServer(app);
 var hostname = '127.0.0.1';
 server.listen(config.port, hostname, () => {
@@ -34,17 +39,14 @@ server.listen(config.port, hostname, () => {
   var cmd = '';
   switch (process.platform) {
     case "darwin": //macos
-      cmd = 'open http://127.0.0.1:' + config.port + '/login.html';
+      cmd = 'open http://127.0.0.1:' + config.port + '/';
       break;
     case "win32": //windows
-      cmd = 'explorer http://127.0.0.1:' + config.port + '/login.html';
+      cmd = 'explorer http://127.0.0.1:' + config.port + '/';
       break;
   }
   if (cmd) {
+    if (config.modName) cmd += 'login.html'; // ngp的启动文件
     require('child_process').exec(cmd);
   }
-});
-
-
-// 自定义打包js
-require('./ngptool.js');
+});

package/lib/utils.js

@@ -3,6 +3,7 @@ var path = require('path');
 const crypto = require('crypto');
 var iconv = require('iconv-lite');
 var config = require('./config.js');
+var logErr = console.dir.bind(console);
 
 Buffer.prototype.toByteArray = function() {
     return Array.prototype.slice.call(this, 0)
@@ -31,7 +32,7 @@ Date.prototype.toJSON = function() {
 
 
 /* 全局公共类 */
-class utils {
+class Utils {
     constructor() {
         this.cryptoKey = '$wssf20119@.Z+Q$';
     }
@@ -93,7 +94,7 @@ class utils {
     }
 
     getQueryInt(req, key) {
-        var v = that.getQueryValue(req, key);
+        var v = utils.getQueryValue(req, key);
         if (v == null) return 0;
         v = parseInt(v);
         if (isNaN(v)) return 0;
@@ -101,7 +102,7 @@ class utils {
     }
 
     getFormValue(req, key) {
-        var query = that.getReqBody(req);
+        var query = utils.getReqBody(req);
         if (!query) return null;
         if (query[key] == undefined) return null;
         var value = query[key];
@@ -134,7 +135,7 @@ class utils {
         }
 
         var errorObj = {
-            "Message": that.makeExceptionHtml(ex, false)
+            "Message": utils.makeExceptionHtml(ex, false)
         };
         res.end(JSON.stringify(errorObj));
     }
@@ -173,7 +174,7 @@ class utils {
         // 设置允许跨域
         var origin = res.req.headers["origin"];
         var host = res.req.headers['host'];
-        if (origin == undefined || that.endsWithIgnoreCase(origin, host)) return; // 非跨域请求
+        if (origin == undefined || utils.endsWithIgnoreCase(origin, host)) return; // 非跨域请求
         if (allowOrigins.length > 0 && !allowOrigins.includes(origin)) return; // 如果当前请求域名不在运行范围内，不添加跨域请求头
 
         if (!isOPTIONS) {
@@ -196,7 +197,7 @@ class utils {
         var isOPTIONS = req.method == "OPTIONS";
         var allowHeaders = 'X-Requested-With,Content-Type';
 
-        that.setCORSHeader(res, [], allowHeaders, isOPTIONS); // 预先检查并统一输出跨域请求头
+        utils.setCORSHeader(res, [], allowHeaders, isOPTIONS); // 预先检查并统一输出跨域请求头
 
         if (isOPTIONS) { // 跨域请求预检查
             res.end('ok'); // 完成正常的响应，则允许跨域
@@ -206,27 +207,32 @@ class utils {
         next(); // 继续处理
     }
 
+    // 清空整个目录，包括子目录和文件
     cleardirsSync(dirname) {
         if (!fs.existsSync(dirname)) return;
 
-        var files = fs.readdirSync(dirname);
-        files.forEach(function(itm, index) {
-            var file = path.join(dirname, itm);
-            var stat = fs.statSync(file);
-            if (stat.isDirectory()) {
+        fs.readdirSync(dirname).forEach(function(file) {
+            var filePath = path.join(dirname, file);
+            if (fs.statSync(filePath).isDirectory()) {
                 //递归读取文件
-                that.cleardirsSync(file);
+                utils.cleardirsSync(filePath);
             } else {
-                fs.unlinkSync(file);
+                //utils.debug('del path ' + filePath);
+                fs.unlinkSync(filePath);
             }
         });
+
+        //utils.debug('del file ' + dirname);
+        fs.rmdirSync(dirname);
     }
 
+    // 递归创建目录
     mkdirsSync(dirname) {
+        if (dirname.indexOf('.') > 0) dirname = path.dirname(dirname);
         if (fs.existsSync(dirname)) {
             return true;
         }
-        if (that.mkdirsSync(path.dirname(dirname))) {
+        if (utils.mkdirsSync(path.dirname(dirname))) {
             fs.mkdirSync(dirname);
             return true;
         }
@@ -236,9 +242,21 @@ class utils {
         if (byte[0] == 0xef && byte[1] == 0xbb || byte[0] == 0xfe && byte[1] == 0xff || byte[0] == 0xff && byte[1] == 0xfe) {
             return byte.toString(); //utf8 + bom
         } else {
-            var newByte = iconv.decode(byte, __from_code);
+            var newByte = iconv.decode(byte, 'UTF8');
             if (newByte.indexOf('�') > -1) return byte.toString(); // utf8上面没法识别出来，转换后反而会乱码，其实utf8不用转换，直接返回就行了
-            return newByte.toString(__to_code);
+            return newByte.toString('UTF8');
+        }
+    }
+
+    isUtf8(byte, from_code) {
+        // 84, 121
+        // 239, 187
+        if (byte[0] == 0xef && byte[1] == 0xbb || byte[0] == 0xfe && byte[1] == 0xff || byte[0] == 0xff && byte[1] == 0xfe) {
+            return true;
+        } else {
+            var newByte = iconv.decode(byte, from_code || 'utf-8');
+            if (newByte.indexOf('�') > -1) return true; // utf8上面没法识别出来，转换后反而会乱码，其实utf8不用转换，直接返回就行了
+            return false;
         }
     }
 
@@ -251,16 +269,25 @@ class utils {
 
     log() {
         var args = [];
-        args.push(`[${new Date().toString()}]`);
+        if (config.Debug) args.push(`[${new Date().toString()}]`);
         for (var i = 0, count = arguments.length; i < count; i++) {
             args.push(arguments[i]);
         }
         console.log.apply(console, args);
     }
 
+    error(text) {
+        logErr(text);
+    }
+
+    debug() {
+        if (!config.Debug) return;
+        utils.log.apply(utils, arguments);
+    }
+
     rewriteCrabaJs(req, res, next) {
         var url = req.originalUrl;
-        that.log(url);
+        //utils.log(url);
 
         /*
         var apiStart = '/apis/';
@@ -278,7 +305,7 @@ class utils {
             throw new Error('平台前端组件不存在，请检查:' + crabaJs);
         }
 
-        var clientSocketJs = path.join(__dirname, 'client/client.js');
+        var clientSocketJs = path.join(__dirname, '../tool/client.js');
         var content = fs.readFileSync(crabaJs).toString();
 
         var clientContent = fs.readFileSync(clientSocketJs).toString();
@@ -290,6 +317,57 @@ class utils {
         });
         res.end(content);
     }
-}
 
-var that = module.exports = new utils();
+    getFiles(options, fileList) {
+        var ignores = options.ignores;
+        var exts = options.exts;
+        var source = options.source;
+        if (ignores && !fileList) {
+            ignores = ignores.map((item) => { return path.join(source, item) });
+        }
+
+        if (!fileList) fileList = [];
+        var files = fs.readdirSync(source);
+        files.forEach(function(fileName) {
+            var filePath = path.join(source, fileName);
+            if (ignores && ignores.includes(filePath)) {
+                return;
+            }
+
+            var stat = fs.statSync(filePath);
+            if (stat.isDirectory()) {
+                options.source = filePath;
+                utils.getFiles(options, fileList);
+            } else {
+                if (exts && !exts.includes(path.extname(filePath))) {
+                    return;
+                }
+
+                fileList.push(filePath);
+            }
+        });
+        return fileList;
+    }
+
+    copyFiles(source, dest, ignores, cb) {
+        var files = utils.getFiles({ source: source, ignores: ignores });
+        files.forEach(function(fileName) {
+            fileName = fileName.replace(source, ''); // 去掉根路径
+
+            var filePath = path.join(source, fileName);
+            var destPath = path.join(dest, fileName);
+
+            utils.mkdirsSync(destPath);
+
+            var content = fs.readFileSync(filePath);
+            if (cb) {
+                var result = cb(destPath, content); // 显示进度或者自定义替换文本内容
+                if (result) content = result;
+            }
+
+            fs.writeFileSync(destPath, content, 'utf8');
+        });
+    }
+}
+var utils = new Utils();
+module = module.exports = utils;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "crabatool",
-  "version": "1.0.13",
+  "version": "1.0.18",
   "description": "crabatool",
   "main": "index.js",
   "scripts": {
-    "start": "node index.js"
+    "start": "node index.js",
+    "test": "node ./test/test.js"
   },
   "author": "wssf",
   "dependencies": {
@@ -20,7 +21,8 @@
     "sync-request": "^6.1.0",
     "axios": "^0.27.2",
     "single-line-log": "^1.1.2",
-    "node-stream-zip": "^1.15.0"
+    "node-stream-zip": "^1.15.0",
+    "iconv-jschardet": "^2.0.26"
   },
   "repository": {
     "type": "git",

package/test/ngp.js

@@ -1,3 +1,38 @@
-const config = require('./config.js');
-var crabaTool = require('crabatool');
-crabaTool.run(config);
+/**
+ * 项目环境使用工具包
+ */
+
+var crabaTool = require('crabatool'); // 引入craba脚手架工具包
+
+
+// 当前项目相关配置，注意必填项和非必填项哦
+var config = {
+  //【必填】
+  // 告诉工具当前项目的端路径地址，填绝对路径哦
+  webPath: "F:/shell_master/web/src/main/resources/static/shell",
+
+  //【必填】
+  // 告诉工具当前项目前端服务器端口地址
+  port: 3001,
+
+  //【ngp必填】【非ngp项目不是必填】
+  // 当前项目模块名称，各组按需修改
+  modName: "shell", // 如：modName:"jxc"
+
+  // 【不是必填】
+  // 告诉工具当webPath目录下面的js、css、gspx文件发生改变就自动刷新网页
+  refresh: false,
+
+  //【不是必填】
+  // 1. 当前模块是由哪些过去的模块合并来的，各组按需修改
+  // 2. 如果配置了子模块清单，工具会自动将所有子模块下的init.js和当前模块的jxc/js/jxc.js，合并打包到：jxc/js/init.js，实际运行过程中只加载:jxc/js/init.js，不会加载子模块下面的init.js，这样就可以大大减少http请求
+  // 3. 同2，biz.js也是相同思路进行合并打包
+  childModList: [], // 如: ['recordsheet', 'baseinfo', 'accounting'],
+
+  // 【不是必填】
+  // 上一步中打包后的文件是否压缩, true为忽略【不压缩】，false为【要压缩】，各组按需修改
+  ignoreCompress: true
+
+}
+
+crabaTool.run(config); // 传入配置参数，启动工具

package/test/readme.md

@@ -2,17 +2,17 @@
 
 1. 命令行定位到当前目录.
 1. 执行命令：npm install 或 npm update
-1. 打开 config.js，按需修改 config.js
-1. 执行命令：node ngp.js
+1. 打开 craba.js，按需修改 craba.js 内的配置
+1. 执行命令：node craba.js
 
 # 平台助手功能介绍
 
-1. 提供前端资源服务；【实现】
-2. 自动刷新网页，监听到 css、js、gspx 文件有变动，会自动刷新网页，提高开发效率。配置项：config.refresh = true;【实现】
-3. 自动打包 biz.js 和 init.js，针对 ngp 的功能，减少 http 请求；【实现】
-4. 本地服务启动后自动打开浏览器预览页面；【实现】
+1. 提供前端资源服务；
+2. 自动刷新网页，监听到 css、js、gspx 文件有变动，会自动刷新网页，提高开发效率。配置项：config.refresh = true;
+3. 自动打包 biz.js 和 init.js，针对 ngp 的功能，减少 http 请求；
+4. 本地服务启动后自动打开浏览器预览页面；
 
-5. 更新或安装本地 IDEA\VsCode 的智能语法提示；【未实现】
-6. 更新或安装本地 IDEA\VSCode 的新建页面模板；【未实现】
-7. 新建空白项目和 ngp 项目；【未实现】
-8. 根据配置将当前项目所有业务 js 文件统一打包、es6 语法转换、文件合并；【未实现】
+5. 更新或安装本地 IDEA\VsCode 的智能语法提示；
+6. 更新或安装本地 IDEA\VSCode 的新建页面模板；
+7. 新建空白项目和 ngp 项目；
+8. 根据配置将当前项目所有业务 js 文件统一打包、es6 语法转换、文件合并；

package/test/test.js

@@ -0,0 +1,38 @@
+/**
+ * 本地测试工具包
+ */
+
+var crabaTool = require('../index.js'); // 引入craba脚手架工具包
+
+
+// 当前项目相关配置，注意必填项和非必填项哦
+var config = {
+  //【必填】
+  // 告诉工具当前项目的端路径地址，填绝对路径哦
+  webPath: "F:/shell_master/web/src/main/resources/static/shell",
+
+  //【必填】
+  // 告诉工具当前项目前端服务器端口地址
+  port: 3001,
+
+  //【ngp必填】【非ngp项目不是必填】
+  // 当前项目模块名称，各组按需修改
+  modName: "shell", // 如：modName:"jxc"
+
+  // 【不是必填】
+  // 告诉工具当webPath目录下面的js、css、gspx文件发生改变就自动刷新网页
+  refresh: true,
+
+  //【不是必填】
+  // 1. 当前模块是由哪些过去的模块合并来的，各组按需修改
+  // 2. 如果配置了子模块清单，工具会自动将所有子模块下的init.js和当前模块的jxc/js/jxc.js，合并打包到：jxc/js/init.js，实际运行过程中只加载:jxc/js/init.js，不会加载子模块下面的init.js，这样就可以大大减少http请求
+  // 3. 同2，biz.js也是相同思路进行合并打包
+  childModList: ['recordsheet', 'baseinfo', 'accounting'],
+
+  // 【不是必填】
+  // 上一步中打包后的文件是否压缩, true为忽略【不压缩】，false为【要压缩】，各组按需修改
+  ignoreCompress: true
+
+}
+
+crabaTool.run(config); // 传入配置参数，启动工具