@lytjs/plugin-logger 4.2.0 → 5.0.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 +135 -0
- package/dist/index.cjs +2 -2
- package/dist/index.mjs +2 -2
- package/dist/types/index.d.ts +6 -1
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# @lytjs/plugin-logger
|
|
2
|
+
|
|
3
|
+
> Lyt.js 日志插件 - 提供分级日志记录、日志过滤和持久化存储功能
|
|
4
|
+
|
|
5
|
+
**版本：** 4.2.0
|
|
6
|
+
|
|
7
|
+
## 安装
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @lytjs/plugin-logger
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## 使用
|
|
14
|
+
|
|
15
|
+
### 注册插件
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { createApp } from '@lytjs/core'
|
|
19
|
+
import { createLogger } from '@lytjs/plugin-logger'
|
|
20
|
+
|
|
21
|
+
const logger = createLogger({
|
|
22
|
+
level: 'debug',
|
|
23
|
+
prefix: '[Lyt]',
|
|
24
|
+
persist: true,
|
|
25
|
+
maxLogs: 1000,
|
|
26
|
+
})
|
|
27
|
+
|
|
28
|
+
const app = createApp({})
|
|
29
|
+
app.use(logger)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### 基本日志输出
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
logger.debug('调试信息', { foo: 'bar' })
|
|
36
|
+
logger.info('普通信息')
|
|
37
|
+
logger.warn('警告信息')
|
|
38
|
+
logger.error('错误信息', new Error('出错了'))
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 动态调整日志级别
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
// 开发环境使用 debug
|
|
45
|
+
logger.setLevel('debug')
|
|
46
|
+
|
|
47
|
+
// 生产环境使用 warn
|
|
48
|
+
logger.setLevel('warn')
|
|
49
|
+
|
|
50
|
+
// 关闭所有日志
|
|
51
|
+
logger.setLevel('silent')
|
|
52
|
+
|
|
53
|
+
// 获取当前级别
|
|
54
|
+
logger.getLevel() // 'warn'
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 自定义传输
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
const logger = createLogger({
|
|
61
|
+
level: 'info',
|
|
62
|
+
transport: (log) => {
|
|
63
|
+
// 发送日志到远程服务器
|
|
64
|
+
fetch('/api/logs', {
|
|
65
|
+
method: 'POST',
|
|
66
|
+
body: JSON.stringify(log),
|
|
67
|
+
})
|
|
68
|
+
},
|
|
69
|
+
})
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 获取和清除日志
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
// 获取所有日志记录
|
|
76
|
+
const logs = logger.getLogs()
|
|
77
|
+
|
|
78
|
+
// 清除日志记录
|
|
79
|
+
logger.clearLogs()
|
|
80
|
+
|
|
81
|
+
// 销毁日志实例，释放资源
|
|
82
|
+
logger.destroy()
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## API
|
|
86
|
+
|
|
87
|
+
### Options
|
|
88
|
+
|
|
89
|
+
| 选项 | 类型 | 默认值 | 描述 |
|
|
90
|
+
|------|------|--------|------|
|
|
91
|
+
| `level` | `'debug' \| 'info' \| 'warn' \| 'error' \| 'silent'` | `'info'` | 日志级别 |
|
|
92
|
+
| `prefix` | `string` | `''` | 日志前缀 |
|
|
93
|
+
| `persist` | `boolean` | `false` | 是否持久化到 localStorage |
|
|
94
|
+
| `maxLogs` | `number` | `1000` | 最大日志条数（FIFO 策略） |
|
|
95
|
+
| `timestamp` | `boolean` | `true` | 是否显示时间戳 |
|
|
96
|
+
| `format` | `string` | - | 自定义格式化模板，例如 `'{timestamp} [{level}] {prefix} {message}'` |
|
|
97
|
+
| `transport` | `(log: LogEntry) => void` | - | 自定义日志传输（如发送到服务器） |
|
|
98
|
+
|
|
99
|
+
### 方法
|
|
100
|
+
|
|
101
|
+
| 方法 | 签名 | 描述 |
|
|
102
|
+
|------|------|------|
|
|
103
|
+
| `debug` | `(...args: any[]) => void` | 输出调试日志 |
|
|
104
|
+
| `info` | `(...args: any[]) => void` | 输出信息日志 |
|
|
105
|
+
| `warn` | `(...args: any[]) => void` | 输出警告日志 |
|
|
106
|
+
| `error` | `(...args: any[]) => void` | 输出错误日志 |
|
|
107
|
+
| `setLevel` | `(level: LogLevel) => void` | 设置日志级别 |
|
|
108
|
+
| `getLevel` | `() => LogLevel` | 获取当前日志级别 |
|
|
109
|
+
| `getLogs` | `() => LogEntry[]` | 获取所有日志记录 |
|
|
110
|
+
| `clearLogs` | `() => void` | 清除日志记录 |
|
|
111
|
+
| `destroy` | `() => void` | 销毁日志实例，释放资源 |
|
|
112
|
+
|
|
113
|
+
### 类型
|
|
114
|
+
|
|
115
|
+
```typescript
|
|
116
|
+
type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent'
|
|
117
|
+
|
|
118
|
+
interface LogEntry {
|
|
119
|
+
level: LogLevel
|
|
120
|
+
message: string
|
|
121
|
+
timestamp: number
|
|
122
|
+
args: any[]
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 特性
|
|
127
|
+
|
|
128
|
+
- **彩色输出**：浏览器环境使用 CSS 样式，Node.js 环境使用 ANSI 颜色码
|
|
129
|
+
- **持久化**：支持将日志存储到 localStorage，页面刷新后可恢复
|
|
130
|
+
- **FIFO 策略**：超过 `maxLogs` 时自动丢弃最早的日志
|
|
131
|
+
- **自定义格式**：通过 `format` 选项自定义日志输出格式
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
MIT
|
package/dist/index.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var
|
|
2
|
-
${r.stack||""}`;try{return JSON.stringify(r,null,2)}catch(n){return String(r)}}).join(" ")}function
|
|
1
|
+
"use strict";var L=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var _=Object.getOwnPropertyNames;var C=Object.prototype.hasOwnProperty;var P=(o,r)=>{for(var n in r)L(o,n,{get:r[n],enumerable:!0})},A=(o,r,n,g)=>{if(r&&typeof r=="object"||typeof r=="function")for(let s of _(r))!C.call(o,s)&&s!==n&&L(o,s,{get:()=>r[s],enumerable:!(g=R(r,s))||g.enumerable});return o};var N=o=>A(L({},"__esModule",{value:!0}),o);var D={};P(D,{createLogger:()=>j});module.exports=N(D);var w={debug:0,info:1,warn:2,error:3,silent:4},h={reset:"\x1B[0m",gray:"\x1B[90m",blue:"\x1B[36m",yellow:"\x1B[33m",red:"\x1B[31m",bold:"\x1B[1m"},E={reset:"",gray:"color: gray",blue:"color: #00bcd4",yellow:"color: #ff9800",red:"color: #f44336",bold:"font-weight: bold"},k=typeof window!="undefined",a="lyt_logger_logs";function S(o){return new Date(o).toISOString()}function J(o){return o.map(r=>{if(r===null)return"null";if(r===void 0)return"undefined";if(typeof r=="string")return r;if(typeof r=="number"||typeof r=="boolean")return String(r);if(r instanceof Error)return`${r.message}
|
|
2
|
+
${r.stack||""}`;try{return JSON.stringify(r,null,2)}catch(n){return String(r)}}).join(" ")}function T(o){let r=k?E:h;switch(o){case"debug":return r.gray;case"info":return r.blue;case"warn":return r.yellow;case"error":return r.red;default:return r.reset}}function O(o){return o.toUpperCase().padEnd(5)}function j(o){let{level:r="info",prefix:n="",persist:g=!1,maxLogs:s=1e3,timestamp:m=!0,format:p,transport:y}=o||{},c=r,t=[],v=!1;if(g)try{let e=localStorage.getItem(a);e&&(t=JSON.parse(e))}catch(e){t=[]}function x(){if(g)try{localStorage.setItem(a,JSON.stringify(t))}catch(e){}}function $(e){if(p)return p.replace("{timestamp}",m?S(e.timestamp):"").replace("{level}",O(e.level)).replace("{prefix}",n).replace("{message}",e.message);let i=[];return m&&i.push(S(e.timestamp)),n&&i.push(n),i.push(`${O(e.level)} ${e.message}`),i.join(" ")}function l(e,i){if(v||w[e]<w[c])return;let f={level:e,message:J(i),timestamp:Date.now(),args:[...i]};t.push(f),t.length>s&&(t=t.slice(t.length-s)),x();let b=T(e),I=$(f);if(k){let d=E.reset,G=b||d;switch(e){case"debug":break;case"info":break;case"warn":break;case"error":break}}else{let d=`${b}${I}${h.reset}`;switch(e){case"debug":break;case"info":break;case"warn":break;case"error":break}}if(y)try{y(f)}catch(d){}}let u={install(e,i){e.config=e.config||{},e.config.globalProperties=e.config.globalProperties||{},e.config.globalProperties.$logger=u,typeof e.provide=="function"&&e.provide("logger",u)},debug(...e){l("debug",e)},info(...e){l("info",e)},warn(...e){l("warn",e)},error(...e){l("error",e)},setLevel(e){c=e},getLevel(){return c},getLogs(){return[...t]},clearLogs(){if(t=[],g)try{localStorage.removeItem(a)}catch(e){}},destroy(){if(v=!0,t=[],g)try{localStorage.removeItem(a)}catch(e){}}};return u}
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var
|
|
2
|
-
${r.stack||""}`;try{return JSON.stringify(r,null,2)}catch(s){return String(r)}}).join(" ")}function
|
|
1
|
+
var b={debug:0,info:1,warn:2,error:3,silent:4},O={reset:"\x1B[0m",gray:"\x1B[90m",blue:"\x1B[36m",yellow:"\x1B[33m",red:"\x1B[31m",bold:"\x1B[1m"},h={reset:"",gray:"color: gray",blue:"color: #00bcd4",yellow:"color: #ff9800",red:"color: #f44336",bold:"font-weight: bold"},E=typeof window!="undefined",l="lyt_logger_logs";function w(t){return new Date(t).toISOString()}function I(t){return t.map(r=>{if(r===null)return"null";if(r===void 0)return"undefined";if(typeof r=="string")return r;if(typeof r=="number"||typeof r=="boolean")return String(r);if(r instanceof Error)return`${r.message}
|
|
2
|
+
${r.stack||""}`;try{return JSON.stringify(r,null,2)}catch(s){return String(r)}}).join(" ")}function R(t){let r=E?h:O;switch(t){case"debug":return r.gray;case"info":return r.blue;case"warn":return r.yellow;case"error":return r.red;default:return r.reset}}function S(t){return t.toUpperCase().padEnd(5)}function C(t){let{level:r="info",prefix:s="",persist:i=!1,maxLogs:d=1e3,timestamp:L=!0,format:m,transport:p}=t||{},a=r,o=[],y=!1;if(i)try{let e=localStorage.getItem(l);e&&(o=JSON.parse(e))}catch(e){o=[]}function k(){if(i)try{localStorage.setItem(l,JSON.stringify(o))}catch(e){}}function x(e){if(m)return m.replace("{timestamp}",L?w(e.timestamp):"").replace("{level}",S(e.level)).replace("{prefix}",s).replace("{message}",e.message);let n=[];return L&&n.push(w(e.timestamp)),s&&n.push(s),n.push(`${S(e.level)} ${e.message}`),n.join(" ")}function g(e,n){if(y||b[e]<b[a])return;let u={level:e,message:I(n),timestamp:Date.now(),args:[...n]};o.push(u),o.length>d&&(o=o.slice(o.length-d)),k();let v=R(e),$=x(u);if(E){let f=h.reset,_=v||f;switch(e){case"debug":break;case"info":break;case"warn":break;case"error":break}}else{let f=`${v}${$}${O.reset}`;switch(e){case"debug":break;case"info":break;case"warn":break;case"error":break}}if(p)try{p(u)}catch(f){}}let c={install(e,n){e.config=e.config||{},e.config.globalProperties=e.config.globalProperties||{},e.config.globalProperties.$logger=c,typeof e.provide=="function"&&e.provide("logger",c)},debug(...e){g("debug",e)},info(...e){g("info",e)},warn(...e){g("warn",e)},error(...e){g("error",e)},setLevel(e){a=e},getLevel(){return a},getLogs(){return[...o]},clearLogs(){if(o=[],i)try{localStorage.removeItem(l)}catch(e){}},destroy(){if(y=!0,o=[],i)try{localStorage.removeItem(l)}catch(e){}}};return c}export{C as createLogger};
|
package/dist/types/index.d.ts
CHANGED
|
@@ -28,10 +28,15 @@ interface LogEntry {
|
|
|
28
28
|
/** 附加参数 */
|
|
29
29
|
args: any[];
|
|
30
30
|
}
|
|
31
|
+
/** 日志插件应用接口（最小化） */
|
|
32
|
+
interface LoggerPluginApp {
|
|
33
|
+
use(plugin: unknown, options?: unknown): void;
|
|
34
|
+
[key: string]: unknown;
|
|
35
|
+
}
|
|
31
36
|
/** 日志插件实例 */
|
|
32
37
|
interface Logger {
|
|
33
38
|
/** 安装到 Lyt 应用 */
|
|
34
|
-
install: (app:
|
|
39
|
+
install: (app: LoggerPluginApp, options?: LoggerOptions) => void;
|
|
35
40
|
/** 调试日志 */
|
|
36
41
|
debug(...args: any[]): void;
|
|
37
42
|
/** 信息日志 */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAkBA,WAAW;AACX,KAAK,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;AAE9D,eAAe;AACf,UAAU,aAAa;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uBAAuB;IACvB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,IAAI,CAAA;CACpC;AAED,WAAW;AACX,UAAU,QAAQ;IAChB,WAAW;IACX,KAAK,EAAE,QAAQ,CAAA;IACf,WAAW;IACX,OAAO,EAAE,MAAM,CAAA;IACf,cAAc;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW;IACX,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,aAAa;AACb,UAAU,MAAM;IACd,iBAAiB;IACjB,OAAO,EAAE,CAAC,GAAG,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAkBA,WAAW;AACX,KAAK,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;AAE9D,eAAe;AACf,UAAU,aAAa;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,QAAQ,CAAA;IAChB,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sBAAsB;IACtB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uBAAuB;IACvB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,IAAI,CAAA;CACpC;AAED,WAAW;AACX,UAAU,QAAQ;IAChB,WAAW;IACX,KAAK,EAAE,QAAQ,CAAA;IACf,WAAW;IACX,OAAO,EAAE,MAAM,CAAA;IACf,cAAc;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW;IACX,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,oBAAoB;AACpB,UAAU,eAAe;IACvB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,aAAa;AACb,UAAU,MAAM;IACd,iBAAiB;IACjB,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,IAAI,CAAA;IAChE,WAAW;IACX,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3B,WAAW;IACX,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC1B,WAAW;IACX,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC1B,WAAW;IACX,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAA;IAC/B,eAAe;IACf,QAAQ,IAAI,QAAQ,CAAA;IACpB,eAAe;IACf,OAAO,IAAI,QAAQ,EAAE,CAAA;IACrB,aAAa;IACb,SAAS,IAAI,IAAI,CAAA;IACjB,aAAa;IACb,OAAO,IAAI,IAAI,CAAA;CAChB;AA0FD;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAoOrD;AAED,OAAO,EAAE,YAAY,EAAE,CAAA;AACvB,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA"}
|