@weapp-core/logger 3.0.2 → 3.1.0
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 +47 -0
- package/dist/index.d.ts +17 -1
- package/dist/index.js +3 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @weapp-core/logger
|
|
2
|
+
|
|
3
|
+
## 简介
|
|
4
|
+
|
|
5
|
+
`@weapp-core/logger` 是基于 consola 的日志封装，提供全局级别控制与按 tag 的细粒度过滤，适合在 weapp-vite 相关工具链中统一输出风格。
|
|
6
|
+
|
|
7
|
+
## 特性
|
|
8
|
+
|
|
9
|
+
- 全局日志级别控制
|
|
10
|
+
- 按 tag 覆盖日志级别
|
|
11
|
+
- API 兼容 consola 的常用用法
|
|
12
|
+
- 内置 `picocolors`，统一终端文本染色
|
|
13
|
+
|
|
14
|
+
## 安装
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
pnpm add @weapp-core/logger
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## 使用
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import logger, { colors, configureLogger } from '@weapp-core/logger'
|
|
24
|
+
|
|
25
|
+
configureLogger({
|
|
26
|
+
level: 'info',
|
|
27
|
+
tags: {
|
|
28
|
+
build: 'warn',
|
|
29
|
+
},
|
|
30
|
+
})
|
|
31
|
+
|
|
32
|
+
logger.info('Hello')
|
|
33
|
+
logger.withTag('build').warn('Build warning')
|
|
34
|
+
|
|
35
|
+
logger.success(colors.green('Build done'))
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## 配置
|
|
39
|
+
|
|
40
|
+
`configureLogger` 选项：
|
|
41
|
+
|
|
42
|
+
- `level`：全局日志级别（`info` / `warn` / `error` / `silent`）
|
|
43
|
+
- `tags`：按 tag 覆盖级别
|
|
44
|
+
|
|
45
|
+
## 相关链接
|
|
46
|
+
|
|
47
|
+
- 仓库：https://github.com/weapp-vite/weapp-vite
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,20 @@
|
|
|
1
|
+
import * as picocolors_types from 'picocolors/types';
|
|
1
2
|
import { ConsolaInstance } from 'consola';
|
|
2
3
|
|
|
4
|
+
/**
|
|
5
|
+
* @description 日志类型
|
|
6
|
+
*/
|
|
3
7
|
type LogType = 'error' | 'warn' | 'info';
|
|
8
|
+
/**
|
|
9
|
+
* @description 日志级别
|
|
10
|
+
*/
|
|
4
11
|
type LogLevel = LogType | 'silent';
|
|
12
|
+
/**
|
|
13
|
+
* @description 终端文本染色工具，基于 picocolors。
|
|
14
|
+
*/
|
|
15
|
+
declare const colors: picocolors_types.Colors & {
|
|
16
|
+
createColors: (enabled?: boolean) => picocolors_types.Colors;
|
|
17
|
+
};
|
|
5
18
|
interface LoggerConfig {
|
|
6
19
|
/**
|
|
7
20
|
* @description 全局日志级别
|
|
@@ -16,7 +29,10 @@ interface LoggerConfig {
|
|
|
16
29
|
*/
|
|
17
30
|
tags?: Record<string, LogLevel | undefined>;
|
|
18
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* @description 设置全局 logger 配置
|
|
34
|
+
*/
|
|
19
35
|
declare function configureLogger(config?: LoggerConfig): void;
|
|
20
36
|
declare const logger: ConsolaInstance;
|
|
21
37
|
|
|
22
|
-
export { type LogLevel, type LogType, type LoggerConfig, configureLogger, logger as default };
|
|
38
|
+
export { type LogLevel, type LogType, type LoggerConfig, colors, configureLogger, logger as default };
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
// src/index.ts
|
|
2
2
|
import { createConsola } from "consola";
|
|
3
|
+
import picocolors from "picocolors";
|
|
4
|
+
var colors = picocolors;
|
|
3
5
|
var baseLogger = createConsola();
|
|
4
6
|
var levelRank = {
|
|
5
7
|
silent: -1,
|
|
@@ -74,6 +76,7 @@ function createLogger(tag) {
|
|
|
74
76
|
var logger = createLogger();
|
|
75
77
|
var index_default = logger;
|
|
76
78
|
export {
|
|
79
|
+
colors,
|
|
77
80
|
configureLogger,
|
|
78
81
|
index_default as default
|
|
79
82
|
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@weapp-core/logger",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "3.0
|
|
4
|
+
"version": "3.1.0",
|
|
5
5
|
"description": "@weapp-core/logger",
|
|
6
6
|
"author": "ice breaker <1324318532@qq.com>",
|
|
7
7
|
"license": "MIT",
|
|
@@ -39,7 +39,8 @@
|
|
|
39
39
|
"node": "^20.19.0 || >=22.12.0"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"consola": "^3.4.2"
|
|
42
|
+
"consola": "^3.4.2",
|
|
43
|
+
"picocolors": "^1.1.1"
|
|
43
44
|
},
|
|
44
45
|
"scripts": {
|
|
45
46
|
"dev": "tsup --watch --sourcemap",
|