mirror of
https://github.com/lobehub/lobehub.git
synced 2026-03-26 13:19:34 +07:00
87 lines
1.5 KiB
Plaintext
87 lines
1.5 KiB
Plaintext
---
|
|
description: 包含添加 console.log 日志请求时
|
|
globs:
|
|
alwaysApply: false
|
|
---
|
|
|
|
# Debug 包使用指南
|
|
|
|
本项目使用 `debug` 包进行调试日志记录。使用此规则来确保团队成员统一调试日志格式。
|
|
|
|
## 基本用法
|
|
|
|
1. 导入 debug 包：
|
|
|
|
```typescript
|
|
import debug from 'debug';
|
|
```
|
|
|
|
1. 创建一个命名空间的日志记录器：
|
|
|
|
```typescript
|
|
// 格式: lobe:[模块]:[子模块]
|
|
const log = debug('lobe-[模块名]:[子模块名]');
|
|
```
|
|
|
|
1. 使用日志记录器：
|
|
|
|
```typescript
|
|
log('简单消息');
|
|
log('带变量的消息: %O', object);
|
|
log('格式化数字: %d', number);
|
|
```
|
|
|
|
## 命名空间约定
|
|
|
|
- 桌面应用相关: `lobe-desktop:[模块]`
|
|
- 服务端相关: `lobe-server:[模块]`
|
|
- 客户端相关: `lobe-client:[模块]`
|
|
- 路由相关: `lobe-[类型]-router:[模块]`
|
|
|
|
## 格式说明符
|
|
|
|
- `%O` - 对象展开（推荐用于复杂对象）
|
|
- `%o` - 对象
|
|
- `%s` - 字符串
|
|
- `%d` - 数字
|
|
|
|
## 示例
|
|
|
|
查看 `src/server/routers/edge/market/index.ts` 中的使用示例：
|
|
|
|
```typescript
|
|
import debug from 'debug';
|
|
|
|
const log = debug('lobe-edge-router:market');
|
|
|
|
log('getAgent input: %O', input);
|
|
```
|
|
|
|
## 启用调试
|
|
|
|
要在开发时启用调试输出，需设置环境变量：
|
|
|
|
### 在浏览器中
|
|
|
|
在控制台执行：
|
|
|
|
```javascript
|
|
localStorage.debug = 'lobe-*';
|
|
```
|
|
|
|
### 在 Node.js 环境中
|
|
|
|
```bash
|
|
DEBUG=lobe-* npm run dev
|
|
# 或者
|
|
DEBUG=lobe-* pnpm dev
|
|
```
|
|
|
|
### 在 Electron 应用中
|
|
|
|
可以在主进程和渲染进程启动前设置环境变量：
|
|
|
|
```typescript
|
|
process.env.DEBUG = 'lobe-*';
|
|
```
|