# whf-weblog

**Repository Path**: whf293/whf-weblog

## Basic Information

- **Project Name**: whf-weblog
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-22
- **Last Updated**: 2025-11-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web监控SDK项目

![GitHub](https://img.shields.io/github/license/username/whf-weblog)
![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)
![Rollup](https://img.shields.io/badge/Rollup-3.0+-green.svg)
![pnpm](https://img.shields.io/badge/pnpm-v10.4.1-orange.svg)

## 项目简介

Web监控SDK是一套完整的前端监控解决方案，包含异常监控、性能监控和用户行为埋点跟踪等核心功能，帮助开发者实时监控线上应用运行状态，及时发现并解决问题。

## 项目架构

项目采用Monorepo架构，使用pnpm workspace进行包管理，包含以下核心包：

```
whf-weblog/
├── packages/
│   ├── sdk-shared/       # 共享工具包，提供类型定义和通用工具函数
│   ├── sdk-monitor/      # 异常监控SDK，捕获JavaScript错误、性能指标等
│   └── sdk-tracker/      # 埋点跟踪SDK，收集用户行为数据
├── rollup.config.js      # 通用构建配置
├── tsconfig.json         # TypeScript配置
└── pnpm-workspace.yaml   # pnpm工作区配置
```

### 包依赖关系

- `@whf/sdk-monitor` 依赖 `@whf/sdk-shared`
- `@whf/sdk-tracker` 依赖 `@whf/sdk-shared`

## 技术栈

- **语言**: TypeScript 5.0+
- **构建工具**: Rollup 3.0+
- **包管理**: pnpm 10.4.1
- **代码规范**: ESLint, Prettier
- **提交规范**: Commitizen, Husky
- **测试框架**: Jest

## 快速开始

### 环境要求

- Node.js 16.x 或更高版本
- pnpm 10.x 或更高版本

### 安装依赖

```bash
# 安装所有依赖
pnpm install
```

### 开发

```bash
# 启动开发模式，监视文件变化并自动构建
pnpm dev
```

### 构建

```bash
# 构建所有包
pnpm build
```

### 测试

```bash
# 运行所有包的测试
pnpm test
```

### 代码规范检查

```bash
# 运行ESLint检查代码质量
pnpm lint

# 使用Prettier格式化代码
pnpm format
```

## 开发维护指南

### 添加新功能

1. 在对应SDK包的src目录下创建新的功能模块
2. 在index.ts中导出新功能
3. 编写相应的类型定义
4. 运行构建和测试确保功能正常

### 发布流程

1. 确保所有测试通过
2. 更新版本号（遵循语义化版本规范）
3. 提交代码并使用标准化提交信息
4. 构建项目
5. 发布到npm仓库

### 提交规范

项目使用Commitizen管理提交信息，运行以下命令使用交互式界面提交：

```bash
pnpm commit
```

提交信息格式遵循Angular Commit Message Guidelines：

```
<type>(<scope>): <subject>

<body>

<footer>
```

常见的type包括：
- feat: 新功能
- fix: 修复bug
- docs: 文档更新
- style: 代码风格调整
- refactor: 代码重构
- test: 测试相关
- chore: 构建过程或辅助工具变动

## 目录说明

### packages/sdk-shared

共享工具包，提供类型定义、工具函数和通用接口，被其他SDK包依赖。

### packages/sdk-monitor

异常监控SDK，主要功能包括：
- JavaScript错误捕获与上报
- 性能指标采集（FCP、LCP、CLS等）
- 白屏检测

### packages/sdk-tracker

埋点跟踪SDK，主要功能包括：
- 页面浏览事件跟踪
- 点击事件跟踪
- 曝光事件跟踪
- 滚动事件跟踪

## 贡献指南

1. Fork项目仓库
2. 创建功能分支
3. 提交代码更改
4. 运行测试确保代码质量
5. 创建Pull Request

## 许可证

本项目采用ISC许可证。详情请查看LICENSE文件。