miniprogram-logger-plus
Advanced tools
+3
-0
@@ -21,2 +21,5 @@ 'use strict' | ||
| this[PREFIX] = options.prefix || ['now', 'duration', 'level'] | ||
| // 默认启用 | ||
| this.enable() | ||
| } | ||
@@ -23,0 +26,0 @@ |
@@ -6,4 +6,9 @@ 'use strict' | ||
| level: 'DEBUG', | ||
| adapter: console, | ||
| adapter: { | ||
| debug: console.log, | ||
| info: console.info, | ||
| warn: console.warn, | ||
| error: console.error, | ||
| }, | ||
| prefix: ['now', 'duration', 'level'], | ||
| } |
+3
-3
@@ -19,5 +19,5 @@ 'use strict' | ||
| function getLevel(level) { | ||
| level = level && level.toUpperCase() | ||
| if (validLevel.includes(level)) { | ||
| return level | ||
| const levelUpper = level.toUpperCase() | ||
| if (validLevel.includes(levelUpper)) { | ||
| return levelUpper | ||
| } | ||
@@ -24,0 +24,0 @@ throwError(level) |
+3
-3
@@ -103,7 +103,7 @@ 'use strict' | ||
| debug(...args) { | ||
| this.log('debug', ...args) | ||
| this.log('debug', args) | ||
| } | ||
| info(...args) { | ||
| this.log('info', ...args) | ||
| this.log('info', args) | ||
| } | ||
@@ -116,3 +116,3 @@ | ||
| error(...args) { | ||
| this.log('error', ...args) | ||
| this.log('error', args) | ||
| } | ||
@@ -119,0 +119,0 @@ |
+2
-2
| { | ||
| "name": "miniprogram-logger-plus", | ||
| "version": "1.0.1", | ||
| "description": "一款高效实用且可扩展的小程序日志工具", | ||
| "version": "1.1.0", | ||
| "description": "一款高效易用且可扩展的小程序日志工具", | ||
| "main": "index.js", | ||
@@ -6,0 +6,0 @@ "scripts": { |
+33
-76
@@ -7,28 +7,26 @@ # miniprogram-logger-plus | ||
| ## 目录 | ||
| - [介绍](#介绍) | ||
| - [安装](#安装) | ||
| - [使用](#使用) | ||
| - [构建 npm](#构建 npm) | ||
| - [入门](#入门) | ||
| - [配置](#配置) | ||
| - [示例](#示例) | ||
| - [作者](#作者) | ||
| - [参与](#参与) | ||
| - [许可证](#许可证) | ||
| - [miniprogram-logger-plus](#miniprogram-logger-plus) | ||
| - [目录](#目录) | ||
| - [介绍](#介绍) | ||
| - [安装](#安装) | ||
| - [使用](#使用) | ||
| - [构建 npm](#构建-npm) | ||
| - [入门](#入门) | ||
| - [配置](#配置) | ||
| - [示例](#示例) | ||
| - [进阶](#进阶) | ||
| - [Logger API](#logger-api) | ||
| - [日志输出源](#日志输出源) | ||
| - [作者](#作者) | ||
| - [参与](#参与) | ||
| - [许可证](#许可证) | ||
| ## 介绍 | ||
| 无论是在开发调试阶段或者线上运行阶段,日志是帮助我们发现问题以及排查修复问题的一个好的工具。依托于微信小程序的高度封装,打印日志变得十分简单。比如使用 `console` 就可以在控制台打印日志,除此之外,微信小程序提供了一款十分实用的 [实时日志](https://developers.weixin.qq.com/miniprogram/dev/framework/realtimelog/) ,它的一个优点是:日志汇聚并实时上报到小程序后台,可直接在小程序后台查看日志,无需人工提交日志。 | ||
| 无论是在开发调试阶段或者线上运行阶段,日志是帮助我们发现问题以及排查修复问题的一个好的工具。依托于微信小程序的高度封装,打印日志变得十分简单。比如使用 `console` 就可以在控制台打印日志,除此之外,微信小程序提供了一款十分实用的 [实时日志](https://developers.weixin.qq.com/miniprogram/dev/framework/realtimelog/) ,它的一个优点是:日志汇聚并实时上报到小程序后台,可直接在小程序后台查看日志,无需人工提交日志。 | ||
| `miniprogram-logger-plus` 默认集成了上面 `console` 和 `实时日志`,开发者在使用时,可以 `零配置` 使用。 | ||
| ## 安装 | ||
@@ -38,3 +36,2 @@ | ||
| 安装命令: | ||
@@ -46,4 +43,2 @@ | ||
| ## 使用 | ||
@@ -53,4 +48,2 @@ | ||
| ### 构建 npm | ||
@@ -62,4 +55,2 @@ | ||
| 点击后,显示以下界面,表示构建成功。 | ||
@@ -69,4 +60,2 @@ | ||
| 可进入 `miniprogram_npm` 目录进行进一步检查,出现图示红框项目,表示构建成功。 | ||
@@ -76,4 +65,2 @@ | ||
| ### 入门 | ||
@@ -94,4 +81,2 @@ | ||
| ## 配置 | ||
@@ -106,14 +91,10 @@ | ||
| 目前支持以下配置项: | ||
| | 属性 | 类型 | 必填 | 默认值 | 说明 | | ||
| | :---------: | :-----: | :--: | :----: | :----------------------------------------------------------: | | ||
| | 属性 | 类型 | 必填 | 默认值 | 说明 | | ||
| | :---------: | :-----: | :--: | :----: | :-------------------------------------------------------------: | | ||
| | level | string | 否 | 'ALL' | 日志等级,支持:'ALL', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE' | | ||
| | console | boolean | 否 | true | 是否开启 console 日志 | | ||
| | realtimeLog | boolean | 否 | true | 是否开启实时日志(realtimeLog) | | ||
| | console | boolean | 否 | true | 是否开启 console 日志 | | ||
| | realtimeLog | boolean | 否 | true | 是否开启实时日志(realtimeLog) | | ||
| ## 示例 | ||
@@ -126,12 +107,10 @@ | ||
| const logger = new Logger({ | ||
| level: 'WARN', // 日志等级为 'WARN' | ||
| realtimeLog: false, // 关闭实时日志 | ||
| level: 'WARN', // 日志等级为 'WARN' | ||
| realtimeLog: false, // 关闭实时日志 | ||
| }) | ||
| logger.debug('打印 DEBUG 日志') // 当前日志等级('WARN')下将不会打印该日志 | ||
| logger.debug('打印 DEBUG 日志') // 当前日志等级('WARN')下将不会打印该日志 | ||
| logger.warn('打印 WARN 日志') | ||
| ``` | ||
| ## 进阶 | ||
@@ -141,4 +120,2 @@ | ||
| ### Logger API | ||
@@ -152,14 +129,10 @@ | ||
| 使用示例: | ||
| ```js | ||
| logger.level // 'WARN' | ||
| logger.level // 'WARN' | ||
| logger.level = 'INFO' // 将日志等级变更为 'INFO' | ||
| logger.level = 'INFO' // 将日志等级变更为 'INFO' | ||
| ``` | ||
| 方法: | ||
@@ -170,22 +143,14 @@ | ||
| `remove(name: string)` | ||
| 移除一个日志输出源 | ||
| `enable(name: string)` | ||
| 启用一个日志输出源 | ||
| `disable(name: string)` | ||
| 禁用一个日志输出源 | ||
| ### 日志输出源 | ||
| 插件内置了 2 款日志输出源:`console` 和 `realtimeLog`,你除了可以禁用默认的日志输出源外,还可以自定义日志输出源,然后使用 `add` 方法添加该日志输出源,下面介绍一个示例: | ||
| 插件内置了 2 款日志输出源:`console` 和 `realtimeLog`,你除了可以禁用默认的日志输出源外,还可以自定义日志输出源,然后使用 `add` 方法添加该日志输出源,下面介绍一个示例: | ||
@@ -196,12 +161,12 @@ ```js | ||
| name: 'customLog', | ||
| /** 日志等级,仅等于或高于该等级的日志会被传输到当前日志输出源中 */ | ||
| level: 'INFO', | ||
| /** 日志前缀,将会被按序替换为对应内容 */ | ||
| prefix: ['now', 'duration', 'level'], | ||
| /** 适配器,最终将调用该适配器方法打印日志,这里以 console 为例 */ | ||
| adapter: { | ||
| debug: console.debug, | ||
| debug: console.log, | ||
| info: console.info, | ||
@@ -211,3 +176,3 @@ warn: console.warn, | ||
| }, | ||
| // 实际上,以上内容可以缩写为 `adapter: console,` | ||
@@ -231,5 +196,2 @@ } | ||
| ## 作者 | ||
@@ -239,10 +201,7 @@ | ||
| 如果你有任何问题或者建议,欢迎联系我,以下是我的联系方式: | ||
| - 邮箱:inlym@qq.com | ||
| - 主页:[www.inlym.com](https://www.inlym.com) | ||
| - 邮箱:inlym@qq.com | ||
| - 主页:[www.inlym.com](https://www.inlym.com) | ||
| ## 参与 | ||
@@ -257,6 +216,4 @@ | ||
| ## 许可证 | ||
| 本插件使用 [MIT](LICENSE) 许可证。 |
22509
0.96%283
2.54%202
-17.55%