crabatool 1.0.81 → 1.0.83

package/.eslintrc.json

@@ -0,0 +1,52 @@
+{
+    "env": {
+        "browser": true,
+        "es2015": false
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:native-ie/ie11",
+        "plugin:native-ie/ie10"
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "script"
+    },
+    "rules": {
+        "semi": "off",
+        "no-unused-vars": "off",
+        "missingSemi": "off"
+    },
+    "globals": {
+        "Sys": "readonly",
+        "Craba": "readonly",
+        "Type": "readonly",
+        "$app": "readonly",
+        "$common": "readonly",
+        "$settings": "readonly",
+        "$craba": "readonly",
+        "$msg": "readonly",
+        "$print": "readonly",
+        "$notify": "readonly",
+        "$cache": "readonly",
+        "$user": "readonly",
+        "$userCache": "readonly",
+        "$dom": "readonly",
+        "$export": "readonly",
+        "$skin": "readonly",
+        "$step": "readonly",
+        "$ms": "readonly",
+        "$createDelegate": "readonly",
+        "$createControl": "readonly",
+        "$uploader": "readonly",
+        "$debug": "readonly",
+        "$skinUtils": "readonly",
+        "$scriptLoader": "readonly",
+        "$removeNode": "readonly",
+        "$get": "readonly",
+        "$agency": "readonly",
+        "$createControlFromGspx": "readonly",
+        "handleError": "readonly",
+        "$jsLoader": "readonly"
+    }
+}

package/lib/config.js

@@ -9,7 +9,7 @@ class Config {
     this.crabaHooks = "https://oapi.dingtalk.com/robot/send?access_token=ce27b1b1540881540d44c0bd05ba738d865363758892ede137dc1020bd36bd5a";
     //this.webhooks = "https://oapi.dingtalk.com/robot/send?access_token=37279df60e03ebf25e8eb71230ddb93fe74de99951a8d635d0458e60bfcd44d8";
     this.checkgspx = true; // 检查gspx
-
+    this.ignoreCheck = [];
     this.Version = pg.version;
     this.Debug = false;
     //this.SourceHost = "http://crabadoc.mygjp.com.cn";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crabatool",
-  "version": "1.0.81",
+  "version": "1.0.83",
   "description": "crabatool",
   "main": "index.js",
   "scripts": {
@@ -12,23 +12,25 @@
   },
   "author": "wssf",
   "dependencies": {
+    "@jslint-org/jslint": "^2022.5.20",
+    "axios": "^0.27.2",
     "chokidar": "^3.5.3",
+    "compressing": "^1.6.0",
     "compression": "^1.7.4",
+    "crypto": "^1.0.1",
     "express": "^4.17.3",
+    "htmlparser2": "^8.0.1",
+    "iconv-jschardet": "^2.0.26",
     "iconv-lite": "^0.5.2",
-    "uglify-js": "^3.15.1",
-    "readline-sync": "^1.4.10",
-    "single-line-log": "^1.1.2",
-    "crypto": "^1.0.1",
     "nodejs-websocket": "^1.7.2",
+    "readline-sync": "^1.4.10",
     "request": "^2.88.2",
+    "single-line-log": "^1.1.2",
     "sync-request": "^6.1.0",
-    "axios": "^0.27.2",
-    "iconv-jschardet": "^2.0.26",
-    "compressing": "^1.6.0",
-    "@jslint-org/jslint": "^2022.5.20",
-    "htmlparser2": "^8.0.1",
-    "xml-js": "^1.6.11"
+    "uglify-js": "^3.15.1",
+    "xml-js": "^1.6.11",
+    "eslint": "^8.18.0",
+    "eslint-plugin-native-ie": "^0.1.2"
   },
   "repository": {
     "type": "git",
@@ -37,5 +39,6 @@
   "keywords": [
     "crabatool"
   ],
-  "license": "UNLICENSED"
+  "license": "UNLICENSED",
+  "devDependencies": {}
 }

package/test/results.json

@@ -0,0 +1,70 @@
+[
+  {
+    "filePath": "<text>",
+    "messages": [
+      {
+        "ruleId": "native-ie/no-let",
+        "severity": 2,
+        "message": "Do not use let.",
+        "line": 13,
+        "column": 9,
+        "nodeType": "VariableDeclaration",
+        "messageId": "disallow-let",
+        "endLine": 13,
+        "endColumn": 20
+      },
+      {
+        "ruleId": "no-unused-vars",
+        "severity": 2,
+        "message": "'a' is assigned a value but never used.",
+        "line": 13,
+        "column": 13,
+        "nodeType": "Identifier",
+        "messageId": "unusedVar",
+        "endLine": 13,
+        "endColumn": 14
+      },
+      {
+        "ruleId": "native-ie/no-const",
+        "severity": 2,
+        "message": "Do not use const.",
+        "line": 14,
+        "column": 9,
+        "nodeType": "VariableDeclaration",
+        "messageId": "disallow-const",
+        "endLine": 14,
+        "endColumn": 22
+      },
+      {
+        "ruleId": "no-unused-vars",
+        "severity": 2,
+        "message": "'b' is assigned a value but never used.",
+        "line": 14,
+        "column": 15,
+        "nodeType": "Identifier",
+        "messageId": "unusedVar",
+        "endLine": 14,
+        "endColumn": 16
+      },
+      {
+        "ruleId": "no-unused-vars",
+        "severity": 2,
+        "message": "'index' is defined but never used.",
+        "line": 36,
+        "column": 53,
+        "nodeType": "Identifier",
+        "messageId": "unusedVar",
+        "endLine": 36,
+        "endColumn": 58
+      }
+    ],
+    "suppressedMessages": [],
+    "errorCount": 5,
+    "fatalErrorCount": 0,
+    "warningCount": 0,
+    "fixableErrorCount": 0,
+    "fixableWarningCount": 0,
+    "source": "Type.registerNamespace('crabadoc.Admin');\\r\\ncrabadoc.Admin.AQAction = function() {\\r\\n    crabadoc.Admin.AQAction.initializeBase(this);\\r\\n    this.mdRender = new CrabaMarkdown({ isSidebar: false });\\r\\n    this.apiName = 'aq';\\r\\n    this.pageName = 'AQ';\\r\\n};\\r\\n\\r\\ncrabadoc.Admin.AQAction.prototype = {\\r\\n    initialize: function() {\\r\\n        crabadoc.Admin.AQAction.callBaseMethod(this, 'initialize');\\r\\n\\r\\n        let a = 10;\\r\\n        const b = 10;\\r\\n\\r\\n        var tree = this.get_form().tree;\\r\\n        var newNode = tree.get_rootNode().addNode('老文档', { id: 9999, text: '老文档' });\\r\\n        newNode._haschild = true;\\r\\n        newNode.collapse();\\r\\n    },\\r\\n\\r\\n    dispose: function() {\\r\\n        crabadoc.Admin.AQAction.callBaseMethod(this, 'dispose');\\r\\n    },\\r\\n\\r\\n    doExpandClick: function(node) {\\r\\n        $common.ajax({\\r\\n            url: '/apis/aq/getOldDocs',\\r\\n            complete: function(response) {\\r\\n                if (response.get_statusCode() == 200) {\\r\\n                    var list = response.get_object();\\r\\n                    if (list && list.length > 0) {\\r\\n                        list.sort(function(info1, info2) {\\r\\n                            return info1.time - info2.time;\\r\\n                        });\\r\\n                        list.forEach(function(info, index) {\\r\\n                            node.addChild(info.text, info, false, true);\\r\\n                        });\\r\\n                    }\\r\\n                }\\r\\n            }\\r\\n        });\\r\\n    }\\r\\n};\\r\\ncrabadoc.Admin.AQAction.registerClass('crabadoc.Admin.AQAction', crabadoc.Admin.ComListAction);\\r\\n",
+    "usedDeprecatedRules": []
+  }
+]

package/test/test.js

@@ -41,6 +41,8 @@ var config = {
 
   Debug: true,
 
+  globals: ['crabadoc', 'Type', 'CrabaMarkdown', '$doc', 'www', 'crabaJs'],
+
   // 配置js语法检测报告推送地址
   webhooks: ''
   //https://oapi.dingtalk.com/robot/send?access_token=ce27b1b1540881540d44c0bd05ba738d865363758892ede137dc1020bd36bd5a

package/tool/checkjs.js

@@ -6,11 +6,13 @@ var jschardet = require('iconv-jschardet');
 var path = require('path');
 var axios = require('axios');
 var gspx = require('./checkgspx.js');
+var eslint = require('eslint');
+
 
 // js超过多少kb给与提示
 var fileSize = 300;
 // 默认忽略大小的文件
-var sizeBlackList = ['craba.min.js', 'crabaEx.min.js', 'crabaNgp.js', 'echarts-all.js', 'echarts.min.js', 'math.min.js'];
+var blackList = ['agency.js', 'craba.min.js', 'crabaEx.min.js', 'crabaNgp.js', 'echarts-all.js', 'echarts.min.js', 'math.min.js', 'craba.rollup.min.js'];
 // 语法规则，不能包含这些关键词
 var dangerousJs = ['\\slet\\s', '\\sconst\\s', '\=\>\\s?\\(?\\{', '\\sasync\\s', '\\sawait\\s', '\\.then\\(', '\\sdebugger\\s'];
 
@@ -34,7 +36,7 @@ var warnTagsInfo = {
 }
 
 
-module.exports.start = function() {
+module.exports.start = async function() {
   var jsFiles = utils.getFiles({ source: config.webPath, exts: '.js', ignores: config.ignoreCheck });
 
   var errList = [];
@@ -45,23 +47,18 @@ module.exports.start = function() {
 
   // 开始检测
   var pb = new ProgressBar('检查进度', jsFiles.length);
-  jsFiles.forEach(function(filePath) {
-    pb.value++;
-    pb.render({ value: pb.value, text: filePath });
+  //jsFiles.forEach(async function(filePath) {
+  for (var i = 0; i < jsFiles.length; i++) {
+    var filePath = jsFiles[i];
+    var basename = path.basename(filePath);
+    if (blackList.includes(basename)) continue;
 
     var byte = fs.readFileSync(filePath);
-    var stats = fs.statSync(filePath);
-
-    // 简化文件路径
-    filePath = filePath.replace(config.webPath, '');
-
-    // 检查大小
-    if (stats.size / 1024 > fileSize && sizeBlackList.length > 0 && !sizeBlackList.includes(path.basename(filePath))) {
-      bigList.push(`${filePath} ${parseInt(stats.size / 1024)}kb`);
-    }
+    var content = byte.toString();
+    // eslint检查
+    var eslintResults = await eslintCheck(content);
 
     // 检查编码
-    var content = byte.toString();
     var ret = jschardet.detect(byte);
     if (utils.isUtf8(byte, ret.encoding) || ret.encoding == 'UTF-8') {
       utf8List.push(filePath);
@@ -74,24 +71,49 @@ module.exports.start = function() {
         content = utils.toUtf8(byte);
       }
     }
+    pb.value++;
+    pb.render({ value: pb.value, text: filePath });
+
+
+    var stats = fs.statSync(filePath);
+
+    // 简化文件路径
+    filePath = filePath.replace(config.webPath, '');
+
+    // 检查大小
+    if (stats.size / 1024 > fileSize) {
+      bigList.push(`${filePath} ${parseInt(stats.size / 1024)}kb`);
+    }
 
+    var errInfo = { list: [] };
+    if (eslintResults.length > 0 && eslintResults[0].errorCount > 0) {
+      var res = eslintResults[0];
+      errList.push(filePath);
+      errRegList.push(errInfo);
+
+      res.messages.forEach((item) => {
+        errInfo.list.push({ char: item.ruleId + '，' + item.messageId, line: item.line, endLine: item.endLine, column: item.column, msg: item.message });
+      });
+    }
+    continue;
     // ------检查语法1--------
-    var errInfo = { list: null };
     var reg = new RegExp(dangerousJs.join('|'), 'ig');
     if (reg.test(content)) { // 先检查是否有危险字符
       var noComment = utils.clearComment(content);// 去掉注释的代码再查一遍；因为js里面有些危险字符是被注释了的
 
       // 二次检查
       if (reg.test(noComment)) {
-        errList.push(filePath); // 记录该js有异常
+        if (errInfo.list.length == 0) {
+          errList.push(filePath); // 记录该js有异常
+          errRegList.push(errInfo);
+        }
 
         var nreg = new RegExp(dangerousJs.join('|'), 'ig');
         var elist = getMathReuslts(noComment, nreg);
-        errInfo.list = elist;
-        errRegList.push(errInfo);
+        errInfo.list = errInfo.list.concat(elist);
       }
     }
-  });
+  }
   pb.clear('检验完成');
 
   // 检查gspx
@@ -161,11 +183,11 @@ module.exports.start = function() {
       detail.push(`${index + 1}. ${s}`);
 
       var err = errRegList[index];
-      detail.push("| 异常字符 | 位置 |");
-      detail.push("| ----- | ------ |");
+      detail.push("| 异常字符 | 行号 | 列号 | 说明 |");
+      detail.push("| ----- | ------ | ---- | ---- |");
       err.list.forEach((item) => {
-        detail.push(`| ${item.char.trim()} | ${item.index} |`);
-        sonar.issues.push(getSonarEntity('语法异常', modName, item.char.trim(), s, -1, item.index));
+        detail.push(`| ${item.char.trim()} | ${item.line || '-'} | ${item.column || '-'} | ${item.msg || '-'} |`);
+        sonar.issues.push(getSonarEntity('语法异常', modName, item.char.trim(), s, -1, item.line, item.column, item.endLine));
       });
     });
   }
@@ -239,6 +261,20 @@ module.exports.start = function() {
   }
 }
 
+async function eslintCheck(content) {
+  var options = { overrideConfig: { globals: { 'crabadoc': 'readonly' } } };
+  var globals = config.globals;
+  if (globals) {
+    globals.forEach(key => {
+      options.overrideConfig.globals[key] = 'readonly';
+    });
+  }
+  var lint = new eslint.ESLint(options);
+  var res = await lint.lintText(content);
+  //console.log(res);
+  return res;
+}
+
 function getMathReuslts(content, nreg, filterFun) {
   var all = content.matchAll(nreg);
   var list = [];
@@ -246,14 +282,14 @@ function getMathReuslts(content, nreg, filterFun) {
   while (!v.done) {
     var value = v.value[0];
     if (!filterFun || filterFun(value)) {
-      list.push({ "char": value, "index": v.value.index });
+      list.push({ "char": value, "column": v.value.index });
     }
     v = all.next();
   }
   return list;
 }
 
-function getSonarEntity(type, modName, message, filePath, line, col) {
+function getSonarEntity(type, modName, message, filePath, line, column, endLine) {
   var entity = {
     "engineId": modName,
     "ruleId": "no-undef",   // 规则名称，例如不使用const
@@ -261,9 +297,9 @@ function getSonarEntity(type, modName, message, filePath, line, col) {
       "message": message,   // 提示信息
       "filePath": filePath, // 所在文件
       "textRange": {
-        "startLine": line,  // 起始行号
-        "endLine": line,    // 行号
-        "endColumn": col    // 结束字符位置
+        "startLine": line || 0,  // 起始行号
+        "endLine": endLine || 0,    // 行号
+        "endColumn": column || 0    // 结束字符位置
       }
     },
     "type": type,
@@ -299,6 +335,7 @@ function postReport(id, reportUrl, content, sonar) {
     method: 'post',
     url: config.reportHost + '/apis/saveJsReport',
     data: data,
+    maxBodyLength: Infinity,
     headers: { 'Content-Type': 'application/json' },
 
     // proxy: { // 配置代理地址
@@ -309,7 +346,7 @@ function postReport(id, reportUrl, content, sonar) {
     console.log("保存报告ok");
     //console.log(response.data);
   }).catch(function(error) {
-    console.log("保存报告失败，network error");
+    console.log("保存报告失败，" + error.message);
     //console.log(error);
   });
 
@@ -343,8 +380,8 @@ function postWebhooks(id, reportUrl, webhookList) {
     console.log("推送代码检测状态");
     console.log(response.data);
   }).catch(function(error) {
-    console.log("推送代码检测失败");
-    console.log(error);
+    console.log("推送代码检测失败:" + error.message);
+    //console.log(error);
   });
 
   // 如果业务配置的推送地址不是平台群，需要统一推送到平台，汇总一下问题，方便后期统筹
@@ -356,10 +393,10 @@ function postWebhooks(id, reportUrl, webhookList) {
       headers: { 'Content-Type': 'application/json' }
     }).then(function(response) {
       console.log("推送代码检测状态");
-      console.log(response.data);
+      //console.log(response.data);
     }).catch(function(error) {
-      console.log("推送代码检测失败");
-      console.log(error);
+      console.log("推送代码检测失败:" + error.message);
+      //console.log(error);
     });
   }
 }

package/tool/start.js

@@ -24,7 +24,7 @@ class Start {
         "1. 启动服务。\t\t\t\t主要包含：自动合并打包init.js和biz.js，查看本地平台的版本",
         "2. 更新当前项目的平台，然后启动服务。\t主要包含：从<内网>拉取环境相关资源，再拷贝到webPath路径下覆盖老文件，替代手工操作，同时解决npm不稳定问题",
         "3. 查询最新平台版本和日期。\t\t主要包含：从<内网>拉取最新平台版本，开发好及时更新补丁",
-        "4. 校验当前项目前端js语法和兼容性，以及gspx检查。\t主要包含：对本地js语法做一次初步预检避免上线后才发现问题；比如：编码、let、const、=>、async、await、then、缺function",
+        "4. 校验当前项目js和gspx语法。\t\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快捷键",
@@ -80,6 +80,7 @@ class Start {
     bindConfigByArgv('-webhooks');
     bindConfigByArgv('-progress');
     bindConfigByArgv('-childModList', 'array');
+    bindConfigByArgv('-globals', 'array');
     bindConfigByArgv('-ignoreCompress', 'boolean');
     bindConfigByArgv('-Debug', 'boolean');
     bindConfigByArgv('-checkgspx', 'boolean');