@youngbeen/angle-ctrl - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

DebugCtrl.js

@@ -11,3 +11,3 @@ "use strict";
 // import $ from 'jQuery'
-var debug = false; // 是否开启debug模式
+var debug = 0; // debug模式， 0 - 关闭debug，1 - 初级debug（仅alert警告和错误）， 2 - 严格debug（alert所有信息）
 var cheatCounts = 0; // cheat debug点击的累计次数
@@ -53,3 +53,3 @@ var tcCheatDebug = null; // cheat debug time ctrl
 
-    if (debug) {
+    if (debug > 1) {
       // 调试模式打开，打开alert方式
@@ -149,12 +149,15 @@ window.alert(msg);
 
+  // open debug mode -- [mode = 1 | 2]
   debugOn: function debugOn() {
-    debug = true;
+    var mode = arguments[0] === undefined ? 1 : arguments[0];
+
+    debug = mode;
     window.localStorage.debug = debug;
-    window.alert("debug模式调整为" + debug);
+    window.alert("debug模式调整为" + (mode === 2 ? "严格模式" : "开启"));
   },
 
   debugOff: function debugOff() {
-    debug = false;
+    debug = 0;
     window.localStorage.debug = debug;
-    window.alert("debug模式调整为" + debug);
+    window.alert("debug模式调整为关闭");
   },
@@ -169,5 +172,9 @@
       // 切换 cheat debug
-      debug = !debug;
+      if (debug) {
+        debug = 0;
+      } else {
+        debug = 1;
+      }
       window.localStorage.debug = debug;
-      window.alert("debug模式调整为" + debug);
+      window.alert("debug模式调整为开启");
       if (tcCheatDebug) {
@@ -174,0 +181,0 @@ clearTimeout(tcCheatDebug);

package.json

 {
   "name": "@youngbeen/angle-ctrl",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "The controllers used in angle-FE team",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -74,1 +74,137 @@ ## [@youngbeen/angle-ctrl](https://www.npmjs.com/package/@youngbeen/angle-ctrl)
 ```
+
+### debugCtrl
+
+引用
+
+```
+import { debugCtrl } from '@youngbeen/angle-ctrl'
+```
+
+#### 调试打印输出 `log`
+
+```
+debugCtrl.log(info, {
+  isSave: false,
+  line: '',
+  compName: '',
+  funcName: '',
+  attach: ''
+})
+```
+
+* info参数必选，代表信息内容
+* isSave参数可选，代表是否同步记录到前端日志，默认false不记录到前端日志
+* line参数可选，代表信息来源的行数，默认空
+* compName参数可选，代表信息来源的组件名称，默认空
+* funcName参数可选，代表信息来源的方法名称，默认空
+* attach参数可选，代表信息附加的额外信息，默认空
+
+> 该方法始终会在控制台打印出信息，并且当前如果开启了严格调试模式，则会使用弹框方式显示信息
+
+```
+debugCtrl.log('一条普通的消息，不会记录到日志中', {
+  isSave: false
+})
+debugCtrl.log('这条信息会被记录到前端日志', {
+  isSave: true,
+  line: 211,
+  compName: 'HelloWorld',
+  funcName: 'showMsg',
+  attach: 'just a tag'
+})
+```
+
+#### 调试打印警告 `warn`
+
+```
+debugCtrl.warn(info, {
+  line: '',
+  compName: '',
+  funcName: '',
+  attach: ''
+})
+```
+
+* info参数必选，代表警告信息内容
+* line参数可选，代表信息来源的行数，默认空
+* compName参数可选，代表信息来源的组件名称，默认空
+* funcName参数可选，代表信息来源的方法名称，默认空
+* attach参数可选，代表信息附加的额外信息，默认空
+
+> 该方法始终会在控制台打印出警告信息，并且当前如果开启了调试模式，则会使用弹框方式显示信息。另外，该方法打印信息始终会记录到前端日志中。
+
+```
+debugCtrl.warn('发生了一个XXX错误')
+debugCtrl.warn('这条警告包含了一些详细信息', {
+  line: 211,
+  compName: 'HelloWorld',
+  funcName: 'showMsg',
+  attach: '后台数据缺失'
+})
+```
+
+#### 调试打印错误 `error`
+
+```
+debugCtrl.error(info, {
+  line: '',
+  compName: '',
+  funcName: '',
+  attach: ''
+})
+```
+
+* info参数必选，代表错误信息内容
+* line参数可选，代表信息来源的行数，默认空
+* compName参数可选，代表信息来源的组件名称，默认空
+* funcName参数可选，代表信息来源的方法名称，默认空
+* attach参数可选，代表信息附加的额外信息，默认空
+
+> 该方法始终会在控制台打印出警告信息，并且当前如果开启了调试模式，则会使用弹框方式显示信息。另外，该方法打印信息始终会记录到前端日志中，并随后上报发送所有已记录的前端日志
+
+```
+debugCtrl.error('发生了一个XXX严重错误')
+debugCtrl.error('这条错误包含了一些详细信息', {
+  line: 211,
+  compName: 'HelloWorld',
+  funcName: 'showMsg',
+  attach: '后台无响应'
+})
+```
+
+#### 开启调试模式 `debugOn`
+
+```
+debugCtrl.debugOn(mode)
+```
+
+* mode参数可选，代表debug模式，可选值 1 - 普通debug模式（会弹框显示warn，error的信息）， 2 - 严格debug模式（会弹框显示所有log，warn，error类型消息），默认1普通debug模式
+
+```
+debugCtrl.debugOn() // 开启了普通debug模式
+debugCtrl.debugOn(2) // 开启了严格debug模式
+```
+
+#### 关闭调试模式 `debugOff`
+
+```
+debugCtrl.debugOff() // 关闭debug模式
+```
+
+#### 隐藏式点击开启调试模式 `cheatDebugClick`
+
+```
+debugCtrl.cheatDebugClick(count, interval)
+```
+
+* count参数必选，代表需要连续点击多少次目标触发隐藏调试模式
+* interval参数可选，代表连续点击可接受的时间间隔最多值，默认1000ms
+
+> 该方法触发开启的调试模式始终是普通调试模式
+
+```
+debugCtrl.cheatDebugClick(10) // 目标被连续点击10次自动触发开启调试模式
+```
+
+#### 隐藏式迷宫矩阵开启调试模式 `cheatDebugMaze` **_(暂不可用)_**

src/DebugCtrl.js

@@ -6,3 +6,3 @@ // this controller is about to provide functions for debugging controll
 // import $ from 'jQuery'
-let debug = false // 是否开启debug模式
+let debug = 0 // debug模式， 0 - 关闭debug，1 - 初级debug（仅alert警告和错误）， 2 - 严格debug（alert所有信息）
 let cheatCounts = 0 // cheat debug点击的累计次数
@@ -48,3 +48,3 @@ let tcCheatDebug = null // cheat debug time ctrl
 
-    if (debug) {
+    if (debug > 1) {
       // 调试模式打开，打开alert方式
@@ -144,12 +144,13 @@ window.alert(msg)
 
-  debugOn () {
-    debug = true
+  // open debug mode -- [mode = 1 | 2]
+  debugOn (mode = 1) {
+    debug = mode
     window.localStorage.debug = debug
-    window.alert('debug模式调整为' + debug)
+    window.alert(`debug模式调整为${mode === 2 ? '严格模式' : '开启'}`)
   },
 
   debugOff () {
-    debug = false
+    debug = 0
     window.localStorage.debug = debug
-    window.alert('debug模式调整为' + debug)
+    window.alert(`debug模式调整为关闭`)
   },
@@ -162,5 +163,9 @@
       // 切换 cheat debug
-      debug = !debug
+      if (debug) {
+        debug = 0
+      } else {
+        debug = 1
+      }
       window.localStorage.debug = debug
-      window.alert('debug模式调整为' + debug)
+      window.alert('debug模式调整为开启')
       if (tcCheatDebug) {
@@ -167,0 +172,0 @@ clearTimeout(tcCheatDebug)

No alert changes

Improved metrics

Total package byte prevSize

27352

18.84%

Lines of code

657

1.7%

Number of lines in readme file

209

182.43%

No dependency changes