sentry-miniapp 1.7.0 → 1.8.1

package/README.en.md

@@ -1,22 +1,35 @@
 # Sentry Miniapp SDK — Mini Program Monitoring SDK
 
-![npm version](https://img.shields.io/npm/v/sentry-miniapp)
-![npm downloads/month](https://img.shields.io/npm/dm/sentry-miniapp)
-![github forks](https://img.shields.io/github/forks/lizhiyao/sentry-miniapp?style=social)
-![github stars](https://img.shields.io/github/stars/lizhiyao/sentry-miniapp?style=social)
+[![npm version](https://img.shields.io/npm/v/sentry-miniapp)](https://www.npmjs.com/package/sentry-miniapp)
+[![npm downloads/month](https://img.shields.io/npm/dm/sentry-miniapp)](https://www.npmjs.com/package/sentry-miniapp)
+[![github forks](https://img.shields.io/github/forks/lizhiyao/sentry-miniapp?style=social)](https://github.com/lizhiyao/sentry-miniapp/network/members)
+[![github stars](https://img.shields.io/github/stars/lizhiyao/sentry-miniapp?style=social)](https://github.com/lizhiyao/sentry-miniapp/stargazers)
 ![test coverage](https://img.shields.io/badge/test%20coverage-100%25-brightgreen.svg)
-![license](https://img.shields.io/github/license/lizhiyao/sentry-miniapp)
+[![license](https://img.shields.io/github/license/lizhiyao/sentry-miniapp)](./LICENSE)
 
 [简体中文](./README.md) | English
 
-A **mini program monitoring SDK** built on `@sentry/core` (v10.45.0), providing **error monitoring**, **performance monitoring**, offline caching, and distributed tracing. Supports WeChat, Alipay, ByteDance, Baidu, QQ, DingTalk, Kuaishou mini programs and cross-platform frameworks (Taro / uni-app).
+A **mini program monitoring SDK** built on `@sentry/core`, providing **error monitoring**, **performance monitoring**, offline caching, and distributed tracing. Supports WeChat, Alipay, ByteDance, Baidu, QQ, DingTalk, Kuaishou mini programs and cross-platform frameworks (Taro / uni-app).
 
 > **What are Mini Programs?** Mini programs (小程序) are lightweight apps that run inside super-apps like WeChat, Alipay, and ByteDance/Douyin. They form a massive ecosystem in China with **hundreds of millions of daily active users**, but have no direct equivalent in the Western tech stack. Think of them as a hybrid between PWAs and native apps, but hosted within a platform's sandbox.
 
-> **Version Notes**
->
-> - `v1.x.x`: New architecture based on Sentry V10 core. Full support for WeChat, Alipay, ByteDance, Baidu, QQ, DingTalk, Kuaishou mini programs and cross-platform frameworks (Taro / uni-app).
-> - `v0.x.x`: Legacy version, no longer maintained.
+> **📰 Featured Article (Chinese)**: [《我把 Sentry 接进了 7 端小程序：从异常捕获、Breadcrumb 到 Source Map 定位》](https://juejin.cn/post/7621871037853843465) — multi-platform integration, Breadcrumb context, offline buffering, and Source Map workflow walked through end-to-end. If you find this project useful, please consider giving it a ⭐ Star.
+
+<details>
+<summary><b>🆕 What's New: v1.3 → v1.8 (click to expand)</b></summary>
+
+| Version | Highlights |
+|---|---|
+| **v1.8.0** | AI-assisted integration skill — auto onboarding via Claude Code / Cursor |
+| **v1.7.0** | New `tracesSampler` for dynamic sampling; complete Source Map configuration guide |
+| **v1.6.0** | 13 enhancements + 16 fixes; enabled esbuild minification — bundle size reduced by ~**59%** |
+| **v1.5.0** | Performance enhancements (configurable thresholds / slow `setData` detection / memory sampling); new page lifecycle, user interaction, and Console breadcrumbs; route integration covers all platforms |
+| **v1.4.0** | `NetworkBreadcrumbs` captures Request / Response body; configurable offline cache limit; deprecated `showReportDialog` in favor of `captureFeedback` |
+| **v1.3.0** | 🎯 Build pipeline rewrite (Vite + bundle-inline): **zero external deps**, fully resolves the `miniprogram_npm` module-resolution issue; 🎯 built-in Source Map path normalization across all platforms |
+
+See [CHANGELOG.md](./CHANGELOG.md) for full details.
+
+</details>
 
 ---
 
@@ -41,7 +54,7 @@ A **mini program monitoring SDK** built on `@sentry/core` (v10.45.0), providing
 ## Installation
 
 ```bash
-npm install sentry-miniapp --save
+npm install sentry-miniapp
 ```
 
 > **Note:** Starting from `v1.1.0`, the build strategy has been optimized (dependencies are inlined), so there is **no need** to install `@sentry/core` separately.
@@ -50,6 +63,18 @@ npm install sentry-miniapp --save
 
 ---
 
+## AI-Assisted Setup
+
+If you use [Claude Code](https://claude.ai/code) or [Cursor](https://cursor.com), get AI-guided setup with one command:
+
+```bash
+npx skills add https://github.com/lizhiyao/sentry-miniapp --skill sentry-miniapp-sdk
+```
+
+After installation, just ask "help me set up Sentry monitoring" in your AI editor.
+
+---
+
 ## Quick Start
 
 ### 1. Prerequisites
@@ -155,13 +180,15 @@ Sentry.addBreadcrumb({
 ### Custom Performance Measurement
 
 ```javascript
-// Mark start point
-Sentry.addPerformanceMark('api-request-start');
-// ... perform operation
-Sentry.addPerformanceMark('api-request-end');
-
-// Measure the interval
-Sentry.measurePerformance('fetch-user-data', 'api-request-start', 'api-request-end');
+await Sentry.startSpan(
+  {
+    name: 'fetch-user-data',
+    op: 'http.client',
+  },
+  async () => {
+    await fetchUserData();
+  },
+);
 ```
 
 ### Dynamic Sampling (tracesSampler)
@@ -309,20 +336,6 @@ If errors are not being reported, check:
 
 ---
 
-## Contributing
-
-We welcome Pull Requests and Issues!
-
-Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.
-
-Quick start:
-
-1. `npm install` — install dependencies
-2. `npm run dev` — start watch mode
-3. `npm run test:all` — run full test suite (unit + integration)
-
----
-
 ## Community
 
 Have questions or want to discuss mini program monitoring? Join our community.

package/README.md

@@ -1,20 +1,33 @@
 # Sentry Miniapp SDK — 小程序监控 SDK
 
-![npm version](https://img.shields.io/npm/v/sentry-miniapp)
-![npm download](https://img.shields.io/npm/dm/sentry-miniapp)
-![github forks](https://img.shields.io/github/forks/lizhiyao/sentry-miniapp?style=social)
-![github stars](https://img.shields.io/github/stars/lizhiyao/sentry-miniapp?style=social)
+[![npm version](https://img.shields.io/npm/v/sentry-miniapp)](https://www.npmjs.com/package/sentry-miniapp)
+[![npm download](https://img.shields.io/npm/dm/sentry-miniapp)](https://www.npmjs.com/package/sentry-miniapp)
+[![github forks](https://img.shields.io/github/forks/lizhiyao/sentry-miniapp?style=social)](https://github.com/lizhiyao/sentry-miniapp/network/members)
+[![github stars](https://img.shields.io/github/stars/lizhiyao/sentry-miniapp?style=social)](https://github.com/lizhiyao/sentry-miniapp/stargazers)
 ![test coverage](https://img.shields.io/badge/test%20coverage-100%25-brightgreen.svg)
-![license](https://img.shields.io/github/license/lizhiyao/sentry-miniapp)
+[![license](https://img.shields.io/github/license/lizhiyao/sentry-miniapp)](./LICENSE)
 
 简体中文 | [English](./README.en.md)
 
-一个基于 `@sentry/core` (v10.45.0) 核心构建的**小程序监控 SDK**，提供**异常监控**、**性能监控**、离线缓存、分布式追踪等能力。支持微信、支付宝、字节跳动、百度、QQ、钉钉、快手等多端小程序及 Taro / uni-app 等跨端框架。
+一个基于 `@sentry/core` 核心构建的**小程序监控 SDK**，提供**异常监控**、**性能监控**、离线缓存、分布式追踪等能力。支持微信、支付宝、字节跳动、百度、QQ、钉钉、快手等多端小程序及 Taro / uni-app 等跨端框架。
 
-> **💡 版本说明**
->
-> - `v1.x.x`：全新架构，基于 Sentry V10 核心，全面支持微信、支付宝、字节跳动、百度、QQ、钉钉、快手等多端小程序及主流跨端框架（Taro / uni-app 等）。
-> - `v0.x.x`：旧版本，已停止维护。
+> **📰 最新文章**：[《我把 Sentry 接进了 7 端小程序：从异常捕获、Breadcrumb 到 Source Map 定位》](https://juejin.cn/post/7621871037853843465) — 多端统一接入、Breadcrumb 上下文、弱网兜底、Source Map 实战，一篇串完整套方案。觉得有用请帮忙点个 ⭐ Star，让更多小程序团队找到它。
+
+<details>
+<summary><b>🆕 v1.3 → v1.8 What's New（点击展开）</b></summary>
+
+| 版本 | 亮点 |
+|---|---|
+| **v1.8.0** | AI 辅助接入 skill — Claude Code / Cursor 自动引导集成 |
+| **v1.7.0** | 新增 `tracesSampler` 动态采样；新增 Source Map 完整配置指南 |
+| **v1.6.0** | 13 项功能优化 + 16 项问题修复；启用 esbuild 压缩，包体积减少约 **59%** |
+| **v1.5.0** | Performance 增强（可配阈值 / setData 慢渲染检测 / 内存采集）；新增页面生命周期、用户交互、Console 三类 Breadcrumb；Route 集成全平台适配 |
+| **v1.4.0** | NetworkBreadcrumbs 抓 Request / Response Body；离线缓存上限可配；废弃 `showReportDialog` 引导至 `captureFeedback` |
+| **v1.3.0** | 🎯 重构构建（迁移 Vite + bundle-inline）：对外**零依赖**，彻底修掉「`miniprogram_npm` 模块解析」问题；🎯 内置 Source Map 路径自动抹平，跨端堆栈统一映射 |
+
+完整变更见 [CHANGELOG.md](./CHANGELOG.md)。
+
+</details>
 
 ---
 
@@ -41,7 +54,7 @@
 推荐使用 `npm` 进行安装。
 
 ```bash
-npm install sentry-miniapp --save
+npm install sentry-miniapp
 ```
 
 > **注意：** `v1.1.0` 及以上版本已优化构建策略（内联依赖），**无需**再额外安装 `@sentry/core`。
@@ -50,6 +63,18 @@ npm install sentry-miniapp --save
 
 ---
 
+## 🤖 AI 辅助接入
+
+如果你使用 [Claude Code](https://claude.ai/code) 或 [Cursor](https://cursor.com)，AI 可以自动引导你完成接入：
+
+```bash
+npx skills add https://github.com/lizhiyao/sentry-miniapp --skill sentry-miniapp-sdk
+```
+
+安装后，在 AI 编辑器中输入"帮我接入 Sentry 监控"即可触发向导。
+
+---
+
 ## 🚀 快速接入
 
 ### 1. 前置准备
@@ -156,13 +181,15 @@ Sentry.addBreadcrumb({
 ### 自定义性能测速 (Performance)
 
 ```javascript
-// 标记起始点
-Sentry.addPerformanceMark('api-request-start');
-// ... 执行耗时操作
-Sentry.addPerformanceMark('api-request-end');
-
-// 测量并记录该区间
-Sentry.measurePerformance('fetch-user-data', 'api-request-start', 'api-request-end');
+await Sentry.startSpan(
+  {
+    name: 'fetch-user-data',
+    op: 'http.client',
+  },
+  async () => {
+    await fetchUserData();
+  },
+);
 ```
 
 ### 动态采样 (tracesSampler)
@@ -324,18 +351,6 @@ Sentry 官方的 Replay 功能强依赖于浏览器标准 DOM 环境（通过 rr
 
 ---
 
-## 🤝 参与贡献
-
-我们非常欢迎开发者提交 `Pull Request` 或通过 `Issues` 提出宝贵意见！
-
-要参与本地开发：
-
-1. `npm install` 安装依赖
-2. `npm run dev` 启动监听编译
-3. `npm run test:all` 运行完整的单元测试与集成测试套件
-
----
-
 ## 💬 联系与交流
 
 遇到问题？想探讨小程序监控方案？欢迎加入我们的交流群。