@nanyujun/rum-vite-plugin-sourcemap 0.1.0 → 0.1.1

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.

Potentially problematic release.


This version of @nanyujun/rum-vite-plugin-sourcemap might be problematic. Click here for more details.

Files changed (2) hide show
  1. package/README.md +55 -0
  2. package/package.json +5 -2
package/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # @nanyujun/rum-vite-plugin-sourcemap
2
+
3
+ RUM(前端性能监控平台)的 **Vite 插件**,在 `vite build` 完成后自动把产物中的 `*.map` Source Map 上传到 RUM collector,无需手动跑 CLI。上传后线上报错即可在 RUM 后台反混淆。
4
+
5
+ ## 安装
6
+
7
+ ```bash
8
+ npm i -D @nanyujun/rum-vite-plugin-sourcemap
9
+ ```
10
+
11
+ ## 用法
12
+
13
+ ```ts
14
+ import { defineConfig } from 'vite'
15
+ import { rumSourcemap } from '@nanyujun/rum-vite-plugin-sourcemap'
16
+
17
+ export default defineConfig({
18
+ build: {
19
+ sourcemap: 'hidden', // 必须:生成但不随产物发布 .map,避免源码泄漏
20
+ },
21
+ plugins: [
22
+ rumSourcemap({
23
+ app: 'your-app-id',
24
+ release: '1.0.0',
25
+ endpoint: 'https://rum.example.com',
26
+ token: process.env.RUM_ADMIN_TOKEN,
27
+ // distDir: 'dist', // 可选,默认 build.outDir
28
+ // concurrency: 4, // 可选,上传并发
29
+ // disabled: false, // 可选,强制开/关
30
+ }),
31
+ ],
32
+ })
33
+ ```
34
+
35
+ ## 参数
36
+
37
+ | 参数 | 必填 | 说明 |
38
+ | --- | --- | --- |
39
+ | app | 是 | RUM 应用 ID |
40
+ | release | 是 | 版本号,必须与前端 SDK `init({ release })` 一致 |
41
+ | endpoint | 是 | collector 基地址(自动拼 `/admin/sourcemaps`) |
42
+ | token | 是 | `Authorization: Bearer <token>`,缺失则跳过上传 |
43
+ | distDir | 否 | 默认 `config.build.outDir` |
44
+ | concurrency | 否 | 上传并发数 |
45
+ | disabled | 否 | 覆盖默认的「仅 production 启用」策略 |
46
+
47
+ ## 注意事项
48
+
49
+ - 默认仅在 `NODE_ENV=production` 触发上传,可用 `disabled: false` 强制开启
50
+ - `build.sourcemap` 必须设为 `'hidden'`,否则 `.map` 会随产物部署到 CDN,造成源码泄漏
51
+ - `release` 必须与前端 SDK 上报错误时携带的 `release` 一致,否则后台无法匹配对应 map
52
+
53
+ ## 相关
54
+
55
+ - `@nanyujun/rum-sourcemap-cli`:底层上传 CLI / Node API
package/package.json CHANGED
@@ -1,6 +1,8 @@
1
1
  {
2
2
  "name": "@nanyujun/rum-vite-plugin-sourcemap",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
+ "description": "RUM 前端性能监控平台的 Vite 插件:vite build 完成后自动把产物 *.map 上传到 collector,无需手动跑 CLI。",
5
+ "keywords": ["rum", "sourcemap", "source-map", "vite", "vite-plugin", "upload", "monitoring", "error-tracking"],
4
6
  "type": "module",
5
7
  "publishConfig": {
6
8
  "access": "public"
@@ -16,7 +18,8 @@
16
18
  }
17
19
  },
18
20
  "files": [
19
- "dist"
21
+ "dist",
22
+ "README.md"
20
23
  ],
21
24
  "scripts": {
22
25
  "build": "tsup",