@done-coding/forge-plugin-tour 0.100.0-alpha.0 → 0.100.1-alpha.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.
Files changed (2) hide show
  1. package/README.md +31 -18
  2. package/package.json +4 -5
package/README.md CHANGED
@@ -1,14 +1,40 @@
1
1
  # @done-coding/forge-plugin-tour
2
2
 
3
- 适用于 done-coding 前端框架的新手引导与功能导览插件。
3
+ 新手引导与功能导览插件,复用 forge 徽标锚点与说明。
4
4
 
5
- 文档:https://done-coding.github.io/done-coding-showcase/docs/
5
+ 本包独立安装和使用,不进入 `@done-coding/forge` 聚合。
6
6
 
7
- 本包目录与安装身份已统一为 `forge-plugin-tour`;当前manifest已同版0.100.0-dev.1,公开 API 同步改用 Tour/tour 前缀,不提供旧名别名,改名拟随统一 `0.100.0-alpha.0` 发行。kits/plugins 独立消费,不进入 forge 聚合。
7
+ ## 安装与使用
8
8
 
9
- ## 本机同版候选(id5nov)
9
+ ```bash
10
+ pnpm add @done-coding/forge-plugin-tour @done-coding/forge
11
+ ```
10
12
 
11
- 12公开包现已统一为 `0.100.0-dev.1`,内部依赖保持 `workspace:*` 并在真实pack中转换为精确同版。候选仅用于/tmp可丢弃宿主;没有发布到registry,正式消费项目不写dev字面版本。API 与默认持久化 key 随本次身份调整改变,迁移见 [发布前身份调整](migrations/v0.100.0-dev.1.md)。第一方许可为 MIT,署名 `Copyright (c) JustSoSu`,完整正文见本包 LICENSE。
13
+ ```ts
14
+ import { createTourPlugin } from "@done-coding/forge-plugin-tour";
15
+
16
+ const tour = createTourPlugin();
17
+ // appCoreBridge 为应用已创建的 forge bridge。
18
+ appCoreBridge.use(tour);
19
+ tour.start();
20
+ ```
21
+
22
+ 使用 `start()` / `stop()` 控制导览,`isSeen(key)` / `markSeen(key)` / `reset()` 管理进度。进度使用 bridge storage,默认键为 `tour/seen`,可通过 `storageKey` 配置。
23
+
24
+ 根入口自动引入 driver.js 基础 CSS,`style.css` 为显式兼容出口;两者并用会重复基础样式。主题覆盖在导览启动时注入。driver.js 固定为 1.8.0,随包保留其 MIT 许可;升级时须同步重建 CSS 并验证两种引入方式。
25
+
26
+ ## 消费边界
27
+
28
+ 宿主须满足以下 peer 要求:
29
+
30
+ | 包 | 范围 |
31
+ | -------------------- | ---------- |
32
+ | `@done-coding/forge` | 与本包同版 |
33
+ | `vue` | `^3.4.0` |
34
+
35
+ 文档与完整 API:[使用文档](https://done-coding.github.io/done-coding-showcase/docs/)。
36
+
37
+ MIT,Copyright (c) JustSoSu。完整许可见本包 LICENSE。
12
38
 
13
39
  <!-- repo-map:start -->
14
40
 
@@ -18,22 +44,9 @@
18
44
  - `__tests__/` — 单元测试
19
45
  - `pages/` — 页面
20
46
  - `router/` — 路由
21
- - `migrations/` — 版本迁移说明
22
47
  - `src/` — 源码
23
48
 
24
49
  > 用途:供协作者/AI 按图定位,免遍历目录树。结构变更后重跑初始化刷新。
25
50
  > (模块根的本段展开该模块**内部**结构;深层大目录 ≥8 项或继续分叉则嵌套列出,叶子小目录不展。)
26
51
 
27
52
  <!-- repo-map:end -->
28
-
29
- ## 发行前置契约(rel031实施)
30
-
31
- 根入口继续自动携带driver基础CSS;style.css是显式兼容出口,构建直接取当前driver依赖内容,不需要维护第二份样式。两者并用允许基础样式重复,主题覆盖仍由runner启动时注入。第三方driver原MIT许可随包保留;第一方 MIT 许可正文见仓根与本包 LICENSE。
32
-
33
- ## driver版本一致性(review round1)
34
-
35
- 随包style.css固定构建时版本,根入口自动CSS和runtime driver必须来自同一已验收版本;因此driver依赖精确固定1.8.0。升级driver必须同步重建CSS、复核第三方原许可并运行root/css/both消费回归;不得仅放宽范围让宿主静默升级,双份同内容CSS冗余的接受边界保持。
36
-
37
- ## 自动验证与消费边界(tc7f1a)
38
-
39
- 仓根 `pnpm verify` 检查受影响包,`pnpm verify --all` 检查全量;`pnpm test:consumer` 用十二个真实 tgz 建仓外宿主;`pnpm verify:release` 绑定当前 HEAD 与工作树生成发行戳。任何失败均非零退出,未通过不得发布。本包 prepublishOnly 校验发行戳,不执行发布。exports 的 types 条件优先于运行时条件。ESM 产物的 lodash 子路径使用 `.js` 扩展名;不改变组件 API。消费配置和已知失败见 `scripts/forge-testing.md`,既有工程验证说明保留于 `migrations/v1.0.0-dev.2.md`(历史文件);当前候选为 `0.100.0-dev.1`,不发行。
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@done-coding/forge-plugin-tour",
3
- "version": "0.100.0-alpha.0",
4
- "description": "内部前端库",
3
+ "version": "0.100.1-alpha.0",
4
+ "description": "Forge 新手引导与功能导览插件",
5
5
  "private": false,
6
6
  "main": "es/index.mjs",
7
7
  "module": "es/index.mjs",
@@ -50,7 +50,6 @@
50
50
  ],
51
51
  "devDependencies": {
52
52
  "@done-coding/cli-inject": "0.6.3",
53
- "@done-coding/forge": "0.100.0-alpha.0",
54
53
  "@types/node": "^18.0.0",
55
54
  "@vitejs/plugin-vue": "^5.0.4",
56
55
  "@vitejs/plugin-vue-jsx": "^4.1.2",
@@ -65,7 +64,7 @@
65
64
  "vue-tsc": "^2.2.12"
66
65
  },
67
66
  "peerDependencies": {
68
- "@done-coding/forge": "workspace:*",
67
+ "@done-coding/forge": "0.100.1-alpha.0",
69
68
  "vue": "^3.4.0"
70
69
  },
71
70
  "engines": {
@@ -75,5 +74,5 @@
75
74
  "dependencies": {
76
75
  "driver.js": "1.8.0"
77
76
  },
78
- "gitHead": "c90c37ed0390dfd2b4845fff6ac96c5ab503c6e6"
77
+ "gitHead": "354498c11f54da99165284b76d898d6aaaf92ece"
79
78
  }