@idlebox/logger 0.0.13 → 0.0.14

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/LICENSE CHANGED
@@ -1,21 +1,9 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 GongT<admin@gongt.me>
3
+ Copyright (c) 2026 GongT<admin@gongt.me>
4
4
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
11
6
 
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14
8
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
9
+ THE SOFTWARE IS PROVIDED AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ # 日志工具
2
+
3
+ ## 全局logger对象
4
+ ```ts
5
+ import { logger, createRootLogger } from "@idlebox/logger";
6
+
7
+ createRootLogger('myapp'); // 如果tag为空,则不受“DEBUG”环境变量控制,无条件显示;DEBUG_LEVEL仍然生效
8
+ logger.log`debug message`;
9
+ ```
10
+
11
+ ## 模块logger对象
12
+ ```ts
13
+ import { createLogger } from "@idlebox/logger";
14
+
15
+ const logger = createLogger('myapp:module');
16
+ logger.log`debug message`;
17
+ ```
18
+
19
+ ### 环境变量
20
+
21
+ |环境变量|描述|默认值|
22
+ |:---|:---|:---|
23
+ |DEBUG|调试模式,格式类似“模块1,模块2,模块3”,也可以用空格。底层调用[debug](https://www.npmjs.com/package/debug)包实现判断 |``|
24
+ |DEBUG_LEVEL|日志级别(verbose, debug, info, "", warn, error)|``|
25
+ |NO_COLOR|禁用颜色,任何非空的值都为真|``|
26
+ |NODE_DISABLE_COLORS|同上,但只支持“1”|0|
27
+ |FORCE_COLOR|强制启用颜色,任何非空的值都为真|``|
28
+
29
+ 注意: 如果命令行存在`--verbose`、`-d, --debug`参数,会覆盖`DEBUG_LEVEL`环境变量,两个`-d`=`--verbose`,不支持`-v`。
30
+
31
+ ### 可用命令
32
+
33
+ ```ts
34
+ const veryLongString = "This is a very long string that might be truncated in logs";
35
+ logger.log`don't truncate: long<${veryLongString}>`;
36
+ ```
37
+
38
+ |命令|描述|
39
+ |:---|:---|
40
+ |long|不要省略超长字符串、数组|
41
+ |inspect| 使用util.inspect()来格式化对象 |
42
+ |stripe| 单行显示(转义回车等字符) |
43
+ |list|以列表形式展示,要求参数为Iterable对象,且结果为`string`或`[string, string]`(也可以是实现`toString()`的对象)|
44
+ |commandline|优化显示命令行参数|
45
+ |relative|路径转换为相对于当前工作目录|
46
+ |printable|删除非可打印字符(序列)|
@@ -61,12 +61,14 @@ function syncEnabled(opt, tag, currentLevel) {
61
61
  * 否则启用 >warn 级别
62
62
  * - 如果DEBUG中存在tag:$level,则启用 tag:$level 单个级别
63
63
  *
64
+ * root-logger默认是手动控制
65
+ *
64
66
  * TODO !!
65
67
  */
66
68
  +tag;
67
69
  currentLevel = defaultLogLevel;
68
70
  }
69
- // 手动控制(root-logger默认是手动控制)
71
+ /** 手动控制 */
70
72
  for (const i of [opt.error, opt.warn, opt.info, opt.log, opt.success, opt.debug, opt.verbose]) {
71
73
  i.enable();
72
74
  }
@@ -1 +1 @@
1
- {"version":3,"file":"create.logger.js","sourceRoot":"","sources":["../../src/common/create.logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,cAAc,EAA4C,MAAM,YAAY,CAAC;AAEtF,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAwB,YAAY,CAAC;AAElE,MAAM,UAAU,MAAM,CAAC,GAAW,EAAE,aAAkC,EAAE,MAA8B,EAAE,YAAY,GAAG,cAAc,CAAC,IAAI;IACzI,IAAI,YAAY,GAAG,YAAY,CAAC;IAChC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEtB,IAAI,aAAa,KAAK,SAAS;QAAE,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE3E,MAAM,SAAS,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9G,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACjF,MAAM,OAAO,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACrF,MAAM,IAAI,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/E,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1G,MAAM,OAAO,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9G,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAEpF,OAAO;QACN,GAAG;QACH,MAAM;QACN,KAAK,EAAE,SAAS,KAAK,CAAC,QAAQ,EAAE,GAAG,IAAI;YACtC,SAAS,CAAC,QAAe,EAAE,GAAG,IAAI,CAAC,CAAC;YACpC,MAAM,IAAI,mBAAmB,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;QACtE,CAAC;QACD,KAAK;QACL,IAAI;QACJ,IAAI;QACJ,GAAG;QACH,OAAO;QACP,KAAK;QACL,OAAO;QAEP,YAAY,EAAE,aAAa;QAE3B,MAAM,CAAC,WAA2B;YACjC,YAAY,GAAG,WAAW,CAAC;YAC3B,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,EAAE,CAAC,MAAc,EAAE,EAAE;YAC1B,IAAI,GAAG,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC,GAAG,GAAG,IAAI,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACP,OAAO,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAWD,SAAS,WAAW,CAAC,GAAU,EAAE,GAAW,EAAE,YAA4B;IACzE,IAAI,YAAY,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;QAC1C;;;;;;;;;;;;WAYG;QACH,CAAC,GAAG,CAAC;QACL,YAAY,GAAG,eAAe,CAAC;IAChC,CAAC;IAED,2BAA2B;IAC3B,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/F,CAAC,CAAC,MAAM,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACpB,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;QACvC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3C,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"create.logger.js","sourceRoot":"","sources":["../../src/common/create.logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,cAAc,EAA4C,MAAM,YAAY,CAAC;AAEtF,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;AACvC,MAAM,CAAC,MAAM,gBAAgB,GAAwB,YAAY,CAAC;AAElE,MAAM,UAAU,MAAM,CAAC,GAAW,EAAE,aAAkC,EAAE,MAA8B,EAAE,YAAY,GAAG,cAAc,CAAC,IAAI;IACzI,IAAI,YAAY,GAAG,YAAY,CAAC;IAChC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEtB,IAAI,aAAa,KAAK,SAAS;QAAE,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE3E,MAAM,SAAS,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9G,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACjF,MAAM,OAAO,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACrF,MAAM,IAAI,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/E,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1G,MAAM,OAAO,GAAG,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9G,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAEpF,OAAO;QACN,GAAG;QACH,MAAM;QACN,KAAK,EAAE,SAAS,KAAK,CAAC,QAAQ,EAAE,GAAG,IAAI;YACtC,SAAS,CAAC,QAAe,EAAE,GAAG,IAAI,CAAC,CAAC;YACpC,MAAM,IAAI,mBAAmB,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;QACtE,CAAC;QACD,KAAK;QACL,IAAI;QACJ,IAAI;QACJ,GAAG;QACH,OAAO;QACP,KAAK;QACL,OAAO;QAEP,YAAY,EAAE,aAAa;QAE3B,MAAM,CAAC,WAA2B;YACjC,YAAY,GAAG,WAAW,CAAC;YAC3B,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,EAAE,CAAC,MAAc,EAAE,EAAE;YAC1B,IAAI,GAAG,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC,GAAG,GAAG,IAAI,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACP,OAAO,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAWD,SAAS,WAAW,CAAC,GAAU,EAAE,GAAW,EAAE,YAA4B;IACzE,IAAI,YAAY,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;QAC1C;;;;;;;;;;;;;;WAcG;QACH,CAAC,GAAG,CAAC;QACL,YAAY,GAAG,eAAe,CAAC;IAChC,CAAC;IAED,WAAW;IAEX,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/F,CAAC,CAAC,MAAM,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACpB,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,GAAG,EAAE,CAAC;QACvC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;QACzC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;IACD,IAAI,YAAY,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3C,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;AACF,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@idlebox/logger",
3
3
  "type": "module",
4
- "version": "0.0.13",
4
+ "version": "0.0.14",
5
5
  "description": "A simple logger module for my self use (nodejs).",
6
6
  "exports": {
7
7
  ".": {
@@ -12,14 +12,14 @@
12
12
  },
13
13
  "sideEffects": false,
14
14
  "dependencies": {
15
- "debug": "^4.4.1",
16
- "@idlebox/common": "^1.5.10"
15
+ "debug": "^4.4.3",
16
+ "@idlebox/common": "^1.5.11"
17
17
  },
18
18
  "devDependencies": {
19
19
  "@types/debug": "^4.1.12",
20
- "@types/node": "^24.0.14",
20
+ "@types/node": "^25.0.8",
21
21
  "@build-script/single-dog-asset": "latest",
22
- "@mpis/run": "^0.0.16"
22
+ "@mpis/run": "^0.0.17"
23
23
  },
24
24
  "license": "MIT",
25
25
  "author": "GongT <admin@gongt.me>",
@@ -79,13 +79,16 @@ function syncEnabled(opt: IPass, tag: string, currentLevel: EnableLogLevel) {
79
79
  * 否则启用 >warn 级别
80
80
  * - 如果DEBUG中存在tag:$level,则启用 tag:$level 单个级别
81
81
  *
82
+ * root-logger默认是手动控制
83
+ *
82
84
  * TODO !!
83
85
  */
84
86
  +tag;
85
87
  currentLevel = defaultLogLevel;
86
88
  }
87
89
 
88
- // 手动控制(root-logger默认是手动控制)
90
+ /** 手动控制 */
91
+
89
92
  for (const i of [opt.error, opt.warn, opt.info, opt.log, opt.success, opt.debug, opt.verbose]) {
90
93
  i.enable();
91
94
  }