@jeffchi/logger 1.0.8 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -17
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -19,8 +19,8 @@ A log print output javascript tool library that can be used at the front and bac
|
|
|
19
19
|
- 支持服务端使用, 在服务端使用时默认写入 %root%/logs/yyyy-mm-dd.log 日志文件。
|
|
20
20
|
|
|
21
21
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
|
|
22
|
-
|
|
|
23
|
-
| Edge
|
|
22
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
23
|
+
| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
|
24
24
|
|
|
25
25
|
## 安装
|
|
26
26
|
|
|
@@ -36,23 +36,22 @@ $ yarn add @jeffchi/logger
|
|
|
36
36
|
|
|
37
37
|
如果你的网络环境不佳，推荐使用 [cnpm](https://github.com/cnpm/cnpm)。
|
|
38
38
|
|
|
39
|
-
|
|
40
39
|
## 用法
|
|
41
40
|
|
|
42
41
|
```javascript
|
|
43
42
|
import { loggerWithTags } from '@jeffchi/logger';
|
|
44
43
|
import { LogLevel, LogMode } from '@jeffchi/logger/lib/interface';
|
|
45
|
-
const { debug,error,info,log,warn } = loggerWithTags(
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
44
|
+
const { debug, error, info, log, warn } = loggerWithTags(
|
|
45
|
+
'api', // ['api','get'] 一个或多个tag
|
|
46
|
+
{
|
|
47
|
+
level: LogLevel.LOG, // 日志级别只有指定级别的日志才会输出至日志文件
|
|
48
|
+
date: 'MMM dd, yyyy HH:mm:ss.sss', // 日志输出的时间戳格式,true表示使用默认utc IOS日期时间格式,false表示不输出时间戳
|
|
49
|
+
env: LogMode.ALL, // 环境参数,开发版本或生产版本,如果指定开发环境,则生产环境不输出任何内容,也不会写入到日志文件
|
|
50
|
+
disableWarn: false, // 禁用Warn输出,用debug代替,仅影响前端控制台和后端终端,不影响实际内容打印.在跑测试时应该启用,避免影响测试结果
|
|
51
|
+
disableError: false, // 禁用Error输出,用debug代替,仅影响前端控制台和后端终端,不影响实际内容打印.在跑测试时应该启用,避免影响测试结果
|
|
52
|
+
ignoreThrow: false, // 默认Error输出后,会抛出异常,从而打断后端执行流程,可指定true取消该行为,在跑测试时应该启用,避免影响测试测试流程
|
|
53
|
+
outputFile: 'logs/<yyyy-MM-dd>.log', // 输出日志文件的位置,仅服务端使用时有效
|
|
54
|
+
},
|
|
56
55
|
);
|
|
57
56
|
```
|
|
58
57
|
|
|
@@ -70,8 +69,8 @@ export type LogTags = string | string[];
|
|
|
70
69
|
```
|
|
71
70
|
|
|
72
71
|
### options
|
|
73
|
-
```javascript
|
|
74
72
|
|
|
73
|
+
```javascript
|
|
75
74
|
/** 日志配置选项 */
|
|
76
75
|
export interface ILogOptions {
|
|
77
76
|
/** 日志级别
|
|
@@ -113,8 +112,27 @@ export interface ILogOptions {
|
|
|
113
112
|
*/
|
|
114
113
|
outputFile?: string;
|
|
115
114
|
}
|
|
116
|
-
|
|
117
115
|
```
|
|
118
116
|
|
|
119
|
-
##
|
|
117
|
+
## 测试
|
|
118
|
+
|
|
119
|
+
`src/__test__` 目录下的 `*.spec.ts` 和 `*.test.ts` 是测试文件.
|
|
120
|
+
|
|
121
|
+
- `*.spec.ts` 特定于指定版本的测试文件,需要切换到指定版本分支才能保证测试通过
|
|
122
|
+
- `*.test.ts` 当前版本的测试文件
|
|
123
|
+
|
|
124
|
+
> 测试基于 `ts-jest`,终端窗口通过指定参数,来运行特定的测试文件
|
|
125
|
+
>
|
|
126
|
+
> ```bash
|
|
127
|
+
> npm run test 1.0.3 # 1.0.3的测试文件
|
|
128
|
+
> npm run test main # 当前测试文件
|
|
129
|
+
> npm run test # 所有测试文件
|
|
130
|
+
> ```
|
|
131
|
+
|
|
132
|
+
## License
|
|
133
|
+
|
|
120
134
|
MIT
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jeffchi/logger",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"main": "lib/index.js",
|
|
5
5
|
"types": "lib/index.d.ts",
|
|
6
6
|
"description": "A log print output javascript tool library that can be used at the front and back ends",
|
|
@@ -49,7 +49,6 @@
|
|
|
49
49
|
"@types/lodash": "^4.14.191",
|
|
50
50
|
"@types/node": "^18.11.18",
|
|
51
51
|
"jest": "^29.3.1",
|
|
52
|
-
"lodash": "^4.17.21",
|
|
53
52
|
"prettier": "^2.8.2",
|
|
54
53
|
"ts-jest": "^29.0.5",
|
|
55
54
|
"tslint": "^6.1.3",
|