mini-three-adapter 0.0.0-stage → 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.
- package/AGENTS.md +85 -0
- package/LICENSE +21 -0
- package/README.md +158 -2
- package/dist/build/rollup.d.ts +8 -0
- package/dist/build/rollup.js +393 -0
- package/dist/build/rollup.js.map +1 -0
- package/dist/build/vite.d.ts +15 -0
- package/dist/build/vite.js +395 -0
- package/dist/build/vite.js.map +1 -0
- package/dist/chunk-34RWHAW4.js +128 -0
- package/dist/chunk-34RWHAW4.js.map +1 -0
- package/dist/chunk-3UGQWFH3.js +1246 -0
- package/dist/chunk-3UGQWFH3.js.map +1 -0
- package/dist/chunk-4UEBRAK6.js +711 -0
- package/dist/chunk-4UEBRAK6.js.map +1 -0
- package/dist/chunk-LB3WL24R.js +91 -0
- package/dist/chunk-LB3WL24R.js.map +1 -0
- package/dist/chunk-MTBMOFAL.js +132 -0
- package/dist/chunk-MTBMOFAL.js.map +1 -0
- package/dist/chunk-QYQQ5J6E.js +3 -0
- package/dist/chunk-QYQQ5J6E.js.map +1 -0
- package/dist/chunk-V6TY7KAL.js +7 -0
- package/dist/chunk-V6TY7KAL.js.map +1 -0
- package/dist/chunk-WLRQDTSZ.js +145 -0
- package/dist/chunk-WLRQDTSZ.js.map +1 -0
- package/dist/chunk-Z7AMDRN3.js +66 -0
- package/dist/chunk-Z7AMDRN3.js.map +1 -0
- package/dist/core/index.d.ts +101 -0
- package/dist/core/index.js +7 -0
- package/dist/core/index.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -0
- package/dist/platforms/browser.d.ts +23 -0
- package/dist/platforms/browser.js +7 -0
- package/dist/platforms/browser.js.map +1 -0
- package/dist/platforms/wechat-game.d.ts +31 -0
- package/dist/platforms/wechat-game.js +8 -0
- package/dist/platforms/wechat-game.js.map +1 -0
- package/dist/platforms/wechat-miniprogram.d.ts +26 -0
- package/dist/platforms/wechat-miniprogram.js +8 -0
- package/dist/platforms/wechat-miniprogram.js.map +1 -0
- package/dist/plugin-core-BuqW9C-L.d.ts +127 -0
- package/dist/polyfills/index.d.ts +291 -0
- package/dist/polyfills/index.js +4 -0
- package/dist/polyfills/index.js.map +1 -0
- package/dist/runtime-7uUOoFhC.d.ts +263 -0
- package/dist/scope.d.ts +146 -0
- package/dist/scope.js +4 -0
- package/dist/scope.js.map +1 -0
- package/dist/types-BzK0LQMa.d.ts +153 -0
- package/dist/wx-types-NMNyrsWO.d.ts +150 -0
- package/docs/01-design-principles.md +105 -0
- package/docs/02-architecture.md +126 -0
- package/docs/03-module-map.md +99 -0
- package/docs/04-api-reference.md +291 -0
- package/docs/05-build-plugin.md +146 -0
- package/docs/06-platform-notes.md +108 -0
- package/docs/07-integration-guide.md +211 -0
- package/docs/08-extension-guide.md +101 -0
- package/docs/09-testing-and-release.md +206 -0
- package/docs/10-ai-playbook.md +140 -0
- package/docs/11-compat-matrix.md +94 -0
- package/docs/README.md +41 -0
- package/docs/adr/0001-scoped-globals.md +41 -0
- package/docs/adr/0002-unified-runtime-lifecycle.md +40 -0
- package/docs/adr/0003-ast-rewrite.md +51 -0
- package/docs/adr/0004-in-place-patching.md +42 -0
- package/docs/adr/0005-webgl2-only.md +44 -0
- package/docs/adr/0006-zero-three-dependency.md +43 -0
- package/docs/adr/README.md +28 -0
- package/llms.txt +65 -0
- package/package.json +123 -4
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# 09 · 测试、构建与发布
|
|
2
|
+
|
|
3
|
+
## 9.1 常用命令
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install # 安装依赖
|
|
7
|
+
npm run typecheck # tsc --noEmit(strict)
|
|
8
|
+
npm test # vitest run(32 例)
|
|
9
|
+
npm test -- --watch # 观察模式
|
|
10
|
+
npm run build # tsup:dist/*.js + *.d.ts + sourcemap
|
|
11
|
+
npm run check # typecheck + test + build
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Windows 说明:`vitest.config.ts` 使用**单 fork**(`pool: 'forks'`, `singleFork: true`, `fileParallelism: false`, `cache: false`),避免并行 worker 写入系统临时目录时的 `EPERM`。若仍遇到临时目录权限问题:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
TMP="$PWD/.tmp/vitest" TEMP="$PWD/.tmp/vitest" npm test
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## 9.2 测试结构
|
|
21
|
+
|
|
22
|
+
| 文件 | 覆盖 |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `tests/scope-rewrite.test.ts` | AST 重写:自由变量、局部遮蔽、对象键、成员属性、`typeof`、import/export、自定义访问器 |
|
|
25
|
+
| `tests/polyfills.test.ts` | EventTarget/once/remove、PointerEvent、Blob/URL/base64、URL 解析、TextEncoder、fetch、AbortController |
|
|
26
|
+
| `tests/runtime.test.ts` | 画布补丁、scope 隔离、上下文缓存、触摸桥、多指、installGlobals 可逆、resize/dispose、能力报告 |
|
|
27
|
+
| `tests/plugin.test.ts` | 资产扫描、未解析资源、模块过滤、WebGPU 告警、manifest 输出 |
|
|
28
|
+
| `tests/helpers/mock-wx.ts` | 可注入的 `wx` 模拟器(`__setSize`、`__touch`、`__canvases`、`__images`) |
|
|
29
|
+
|
|
30
|
+
**新功能必须带测试**。写测试时优先用 `createMockWx()` 注入,不要在测试里依赖真实 `wx` 或浏览器 DOM。
|
|
31
|
+
|
|
32
|
+
## 9.3 构建产物
|
|
33
|
+
|
|
34
|
+
`tsup.config.ts` 有两套配置:
|
|
35
|
+
|
|
36
|
+
| 配置 | 目标 | 输出 |
|
|
37
|
+
| --- | --- | --- |
|
|
38
|
+
| runtime | `es2019` / `platform: 'neutral'` / splitting / dts | `dist/index.js`、`dist/core/index.js`、`dist/scope.js`、`dist/polyfills/index.js`、`dist/platforms/*.js` + 共享 chunk |
|
|
39
|
+
| build tooling | `node18` / `platform: 'node'` / 不 splitting / dts | `dist/build/vite.js`、`dist/build/rollup.js` |
|
|
40
|
+
|
|
41
|
+
要点:
|
|
42
|
+
|
|
43
|
+
- `es2019` 让 esbuild 降级可选链与空值合并,减少开发者工具的语法报错。
|
|
44
|
+
- `three` 被标记为 `external`,永远不会进适配层产物。
|
|
45
|
+
- `sideEffects` 只声明平台入口文件,保证 tree-shaking 不误删必要的初始化。
|
|
46
|
+
- `.d.ts` 由 tsup/dts 生成,`package.json` 的 `exports` 逐个子路径指向它们。
|
|
47
|
+
|
|
48
|
+
构建后冒烟:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
node --input-type=module -e "
|
|
52
|
+
import { rewriteGlobals } from './dist/build/rollup.js';
|
|
53
|
+
import { miniThree } from './dist/build/vite.js';
|
|
54
|
+
import { createWeChatGameRuntime } from './dist/index.js';
|
|
55
|
+
console.log(typeof rewriteGlobals, typeof miniThree, typeof createWeChatGameRuntime);
|
|
56
|
+
"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## 9.4 建议的 CI 流程
|
|
60
|
+
|
|
61
|
+
```yaml
|
|
62
|
+
# .github/workflows/ci.yml(示意)
|
|
63
|
+
name: ci
|
|
64
|
+
on: [push, pull_request]
|
|
65
|
+
jobs:
|
|
66
|
+
check:
|
|
67
|
+
runs-on: ubuntu-latest
|
|
68
|
+
steps:
|
|
69
|
+
- uses: actions/checkout@v4
|
|
70
|
+
- uses: actions/setup-node@v4
|
|
71
|
+
with: { node-version: 20 }
|
|
72
|
+
- run: npm ci
|
|
73
|
+
- run: npm run check
|
|
74
|
+
- name: Verify examples typecheck
|
|
75
|
+
run: |
|
|
76
|
+
cd examples/wechat-minigame && npm ci && npx tsc --noEmit -p tsconfig.json
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
额外建议:
|
|
80
|
+
|
|
81
|
+
- 在 CI 中打印 `plugin.api.report()`,把 `parseFailures` / `missingAssets` 作为质量门禁(允许白名单)。
|
|
82
|
+
- 建立回归用例集:按 controls / loaders / postprocessing / 动画 / 物理分类,每个类别挑选若干 three 官方示例场景,用 `examples/` 的三种平台工程跑通,结果写进 `docs/11-compat-matrix.md`。
|
|
83
|
+
|
|
84
|
+
## 9.5 发布到 npm
|
|
85
|
+
|
|
86
|
+
### 9.5.1 发布前检查
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
npm run check # typecheck + 32 例测试 + tsup 构建
|
|
90
|
+
npm run release:check # npm pack --dry-run --json,看将要发布的文件清单
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
`package.json` 已配置 `prepublishOnly: "npm run clean && npm run check"`,`npm publish` 会自动清空 `dist/` 并跑一次完整构建与测试,既不会把未构建的产物发出去,也不会带入历史 hash chunk。发布前确认:
|
|
94
|
+
|
|
95
|
+
- `files` 白名单只包含 `dist/`、`README.md`、`AGENTS.md`、`llms.txt`、`docs/`(当前约 73 个文件、156 KB)。
|
|
96
|
+
- `exports` 里每个子路径的 `.js` 与 `.d.ts` 都存在。
|
|
97
|
+
- `CHANGELOG.md` 已补上本次版本条目。
|
|
98
|
+
- `docs/04-api-reference.md` 与 `package.json exports` 一致;`docs/03-module-map.md` 与文件树一致。
|
|
99
|
+
- `docs/11-compat-matrix.md` 已登记验证过的 three / 基础库版本。
|
|
100
|
+
|
|
101
|
+
`package.json` 已配置 `repository` / `homepage` / `bugs`,npm 包页面会展示源码入口与 issue 链接。若仓库迁移,同步修改这三个字段后再发布。
|
|
102
|
+
|
|
103
|
+
### 9.5.2 准备 npm 账号
|
|
104
|
+
|
|
105
|
+
1. 在 [npmjs.com](https://www.npmjs.com/signup) 注册账号,并在 **Account → 2FA** 开启双因素认证。
|
|
106
|
+
2. 检查包名是否可用(发布前再查一次,避免被占用):
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
npm view mini-three-adapter version
|
|
110
|
+
# 404 Not Found = 可用
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
3. 登录:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
npm login # 浏览器授权,最简单
|
|
117
|
+
npm whoami # 确认已登录
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
CI 或非交互环境用 granular access token(权限选 `Read and write`,并限定到该包):
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# 不要把这个文件提交到仓库
|
|
124
|
+
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### 9.5.3 本地演练(推荐先做)
|
|
128
|
+
|
|
129
|
+
生成一个真实 tarball,在干净目录里装一次,确认子路径导入都能解析:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
npm pack # 得到 mini-three-adapter-0.1.0.tgz
|
|
133
|
+
mkdir -p /tmp/m3-smoke && cd /tmp/m3-smoke
|
|
134
|
+
npm init -y && npm pkg set type=module
|
|
135
|
+
npm i /path/to/mini-three-adapter-0.1.0.tgz three
|
|
136
|
+
node --input-type=module -e "
|
|
137
|
+
import { createWeChatGameRuntime } from 'mini-three-adapter/wechat-game';
|
|
138
|
+
import { createWeChatMiniProgramRuntime } from 'mini-three-adapter/wechat-miniprogram';
|
|
139
|
+
import miniThree from 'mini-three-adapter/vite';
|
|
140
|
+
import { getActiveScope } from 'mini-three-adapter/scope';
|
|
141
|
+
console.log(typeof createWeChatGameRuntime, typeof createWeChatMiniProgramRuntime, typeof miniThree, typeof getActiveScope);
|
|
142
|
+
"
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
> 未登录也能执行这一步。`npm pack` 生成的文件记得从仓库目录删掉,或把它加进 `.gitignore`。
|
|
146
|
+
|
|
147
|
+
### 9.5.4 正式发布
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
npm publish --access public
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
`publishConfig.access` 已设为 `public`,`--access public` 可省略。执行后 `prepublishOnly` 会自动清空 `dist/` 并跑 `npm run check`。
|
|
154
|
+
|
|
155
|
+
**npm 的版本号不可覆盖**:同一个 `0.1.0` 只能发一次,之后每次改动都要先升版本再发。24 小时内可以 `npm unpublish <pkg>@<version>` 撤回,超过时间就不能删了;公开包一旦被他人依赖,撤回会影响别人,尽量不要依赖这个能力。
|
|
156
|
+
|
|
157
|
+
### 9.5.5 发布后验证
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
npm view mini-three-adapter version
|
|
161
|
+
npm view mini-three-adapter exports --json
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
在任意新项目里执行 `npm i mini-three-adapter three`,再跑一遍 9.5.3 的 import 冒烟。CDN 会在发布后自动可用(如 `https://unpkg.com/mini-three-adapter/`),但小游戏构建走本地 node_modules,不依赖 CDN。
|
|
165
|
+
|
|
166
|
+
### 9.5.6 后续版本
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
# 修 bug
|
|
170
|
+
npm version patch && npm publish
|
|
171
|
+
# 新增向后兼容能力
|
|
172
|
+
npm version minor && npm publish
|
|
173
|
+
# 破坏性变更(0.x 阶段也用 minor 时要写进 CHANGELOG)
|
|
174
|
+
npm version major && npm publish
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
`npm version` 会自动改 `package.json`、生成 git tag(若已 `git init`)。每次发布重复 9.5.1 的检查。
|
|
178
|
+
|
|
179
|
+
CI 自动发布(`.github/workflows/publish.yml`)要点:用 `actions/setup-node` 配置 `registry-url`,把 `NPM_TOKEN` 放在仓库 Secrets 里,在 `npm ci && npm run check` 之后执行 `npm publish --provenance --access public`。`--provenance` 会在 npm 页面生成来源证明,需要仓库为 public 且 workflow 具备 `id-token: write` 权限。
|
|
180
|
+
|
|
181
|
+
### 9.5.7 其他分发方式
|
|
182
|
+
|
|
183
|
+
| 方式 | 适用场景 |
|
|
184
|
+
| --- | --- |
|
|
185
|
+
| `npm pack` 把 `.tgz` 直接发给同事 | 还没决定公开,或需要在隔离环境试用;对方 `npm i ./xxx.tgz` |
|
|
186
|
+
| `"mini-three-adapter": "file:../.."` | 本机多个项目复用同一份源码 |
|
|
187
|
+
| 私有 registry(Verdaccio / GitHub Packages) | 只给团队内部使用,不想发到公共 npm |
|
|
188
|
+
| `npm link` | 开发期实时联调,改源码立刻生效 |
|
|
189
|
+
|
|
190
|
+
发布到公共 npm 之后,业务项目只需 `npm i mini-three-adapter three`,`examples/*/package.json` 里的 `workspace:*` 改成 `"^0.1.0"` 即可。
|
|
191
|
+
|
|
192
|
+
## 9.6 版本策略
|
|
193
|
+
|
|
194
|
+
- 遵循语义化版本;`0.x` 阶段 minor 可含破坏性变更,但必须在 CHANGELOG 与接入文档里写明。
|
|
195
|
+
- `three` 是 optional peer,`>=0.163.0`(WebGL2 门槛)。three 大版本升级时,重点回归 `DEFAULT_GLOBAL_NAMES` 与 `patchElement` 的属性集合。
|
|
196
|
+
- 微信基础库能力变化只影响 `capabilities.ts` / `wechat-common.ts` / `assets.ts`,不应扩散到 `core/`。
|
|
197
|
+
|
|
198
|
+
## 9.7 真机验收清单(发布前)
|
|
199
|
+
|
|
200
|
+
- [ ] iOS / Android 各一台,WebGL2 正常出图
|
|
201
|
+
- [ ] 多指缩放/旋转(OrbitControls)不卡死,`touchcancel` 后指针计数归零
|
|
202
|
+
- [ ] 横竖屏切换后 `resize` 生效,画面不变形
|
|
203
|
+
- [ ] 前后台切换后帧循环恢复
|
|
204
|
+
- [ ] DRACO / KTX2 资源加载(含分包预下载 Worker)
|
|
205
|
+
- [ ] `runtime.dispose()` 后无残留监听、无内存持续增长
|
|
206
|
+
- [ ] `runtime.report()` 无 WebGL2 告警
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# 10 · AI 协作手册
|
|
2
|
+
|
|
3
|
+
> 目标:让后续任何一次「用 AI 优化 / 迭代适配层」都能在**最小上下文**下做出正确改动。本文件本身可以直接作为系统提示词的一部分。
|
|
4
|
+
|
|
5
|
+
## 10.1 上下文装载顺序(每次会话先做)
|
|
6
|
+
|
|
7
|
+
1. `AGENTS.md` — 架构不变量、命令、修改边界。
|
|
8
|
+
2. `llms.txt` — 全仓库文件索引与一句话摘要。
|
|
9
|
+
3. `docs/03-module-map.md` — 定位要改的文件与下游影响。
|
|
10
|
+
4. `docs/02-architecture.md#25-架构不变量` — 不得破坏的 10 条规则。
|
|
11
|
+
5. 相关 ADR(`docs/adr/`)— 理解「为什么这样」。
|
|
12
|
+
6. 只读取**目标文件 + 其直接依赖**,不要一次性把整个 `src/` 塞进上下文。
|
|
13
|
+
7. 需要确认平台行为时,读 `docs/06-platform-notes.md`;需要确认能力边界时,读 `docs/11-compat-matrix.md`。
|
|
14
|
+
|
|
15
|
+
## 10.2 让 AI 先回答的三个问题(防止瞎改)
|
|
16
|
+
|
|
17
|
+
在动手前要求模型输出:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
1. 这次改动涉及哪些模块?(列出文件路径)
|
|
21
|
+
2. 是否触碰 docs/02 中的任意一条架构不变量?哪一条?
|
|
22
|
+
3. 需要新增/修改哪些测试?验收断言是什么?
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
如果第 2 题答「是」但无法给出 ADR,先写 ADR,再改代码。
|
|
26
|
+
|
|
27
|
+
## 10.3 任务型提示词模板
|
|
28
|
+
|
|
29
|
+
### A. 修复「three 报 xxx is not defined」
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
上下文:AGENTS.md、docs/03-module-map.md、src/build/scope-rewrite.ts、src/scope.ts、src/core/runtime.ts
|
|
33
|
+
任务:three@<版本> 在 <场景> 报错 "<错误信息>"。
|
|
34
|
+
请:
|
|
35
|
+
1) 判断缺失的是「全局标识符」还是「DOM 属性」还是「构造器」;
|
|
36
|
+
2) 按 docs/08 的对应小节做最小改动;
|
|
37
|
+
3) 在 tests/ 里补一个复现用例,先让它失败再修复;
|
|
38
|
+
4) 更新 docs/03 / docs/04 / CHANGELOG.md;
|
|
39
|
+
5) 运行 npm run check,贴出结果。
|
|
40
|
+
约束:不得 import three;不得写 globalThis;不得使用字符串全局替换。
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### B. 新增平台
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
上下文:docs/08#81-新增一个平台、src/core/platform.ts、src/platforms/wechat-game.ts、src/platforms/wx-types.ts
|
|
47
|
+
任务:新增 <平台名> 支持。
|
|
48
|
+
按 docs/08 的 7 步执行,产出:
|
|
49
|
+
- 新平台文件 + 导出 + package.json exports
|
|
50
|
+
- Capabilities 字面量与 docs/11 登记
|
|
51
|
+
- 独立测试文件(用可注入的 mock 宿主)
|
|
52
|
+
- examples/<platform>/ 最小示例
|
|
53
|
+
验收:npm run check 全绿;dispose() 后无残留监听;不调用 wx.createCanvas() 超过一次。
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### C. 升级 three 大版本
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
上下文:docs/11-compat-matrix.md、docs/01-design-principles.md、src/build/scope-rewrite.ts、src/core/element.ts
|
|
60
|
+
任务:适配 three r<版本>。
|
|
61
|
+
请:
|
|
62
|
+
1) 从官方 Migration Guide 列出该版本新增/移除的全局与 DOM 依赖;
|
|
63
|
+
2) 对照 DEFAULT_GLOBAL_NAMES 与 patchElement 属性表,列出差异;
|
|
64
|
+
3) 逐项补实现 + 测试;
|
|
65
|
+
4) 检查 three/addons vs three/examples/jsm 路径、WebGPU 入口、outputColorSpace;
|
|
66
|
+
5) 更新兼容矩阵与 CHANGELOG。
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### D. 性能 / 包体优化
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
上下文:docs/05、docs/06#65、src/build/assets.ts、examples/wechat-minigame/vite.config.ts
|
|
73
|
+
任务:把首包体积降低到 <N>MB。
|
|
74
|
+
请给出:
|
|
75
|
+
- plugin.api.report() 的基线数据
|
|
76
|
+
- manualChunks / 分包 / Brotli / worker 目录的具体配置 diff
|
|
77
|
+
- 每项措施的验证方式与回退方案
|
|
78
|
+
禁止:静默删除资源、隐式改写 WebGLRenderer、破坏 worker 单目录约束。
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### E. 回归一个 three 官方示例场景
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
上下文:examples/wechat-minigame/、docs/11-compat-matrix.md、docs/08-extension-guide.md
|
|
85
|
+
任务:选取一个 three 官方示例场景 <exampleId>(controls / loaders / postprocessing 类别),
|
|
86
|
+
用 examples/wechat-minigame 的入口与构建配置接入并跑通。
|
|
87
|
+
记录到 docs/11-compat-matrix.md:three 版本、基础库、设备、结果、失败原因、所需 polyfill。
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## 10.4 AI 输出的自检清单(要求模型逐条确认)
|
|
91
|
+
|
|
92
|
+
- [ ] 没有新增对 `three` 的运行时 import。
|
|
93
|
+
- [ ] 没有 `new Proxy(canvas)` / `Object.setPrototypeOf` / 克隆画布。
|
|
94
|
+
- [ ] 没有第二次 `wx.createCanvas()`。
|
|
95
|
+
- [ ] 所有新增订阅/定时器/全局写入都登记到 `disposers`。
|
|
96
|
+
- [ ] 构建插件的新行为有开关,默认不改变既有语义。
|
|
97
|
+
- [ ] AST 改写仍通过 `path.scope.hasBinding(name, true)`。
|
|
98
|
+
- [ ] 新增导出已同步到 `src/index.ts` 或对应 `core/index.ts`、`package.json exports`、`docs/04`。
|
|
99
|
+
- [ ] 新增/修改的测试通过,且 `npm run check` 全绿。
|
|
100
|
+
- [ ] `CHANGELOG.md`、`docs/03`(若职责变化)、`docs/11`(若能力变化)已更新。
|
|
101
|
+
|
|
102
|
+
## 10.5 常见 AI 反模式(明确禁止)
|
|
103
|
+
|
|
104
|
+
| 反模式 | 为什么错 | 正确做法 |
|
|
105
|
+
| --- | --- | --- |
|
|
106
|
+
| 「直接在 `globalThis` 上补一个 `window` 就好了」 | 破坏零全局污染与 H5 双端 | `scope` + `installGlobals()` 可逆注入 |
|
|
107
|
+
| 「用正则把 `window` 全替换成 `__m3().window`」 | 误伤局部变量、字符串、对象键 | Babel `ReferencedIdentifier` + scope 判定 |
|
|
108
|
+
| 「新建一个 `class HTMLCanvasElement` 包装 wx canvas」 | 微信内部 WeakMap 按对象身份校验 | 就地 `defineProperty` + `Symbol.hasInstance` |
|
|
109
|
+
| 「在运行时把 `WebGLRenderer.render` 猴补丁一下清深度」 | 隐式、不可观测、与 three 版本强耦合 | 应用层显式 `renderer.clearDepth()`,写进文档 |
|
|
110
|
+
| 「把 three 一起打包进适配层省事」 | 体积、版本冲突、许可 | `three` 保持 optional peer + external |
|
|
111
|
+
| 「WebGPU 不支持就 `try/catch` 回退」 | 小游戏根本没有 WebGPU 且 NodeMaterial 无 WebGL 等价物 | 插件 `webgpu` 策略 + 使用 WebGL 构建目标 |
|
|
112
|
+
| 「能力探测时 `wx.createCanvas().getContext('webgl2')`」 | 偷走唯一上屏画布 | 用 `wx.createOffscreenCanvas()` 探测 |
|
|
113
|
+
|
|
114
|
+
## 10.6 机器可读的报告(给自动化 / CI 用)
|
|
115
|
+
|
|
116
|
+
- 运行期:`runtime.report()` → 能力报告文本。
|
|
117
|
+
- 运行期:`runtime.capabilities` → 结构化对象。
|
|
118
|
+
- 构建期:`plugin.api.report()` → `BuildReport`(模块数、改写数、缺失资源、解析失败、WebGPU 告警)。
|
|
119
|
+
- 构建期:`mini-three-assets.json` → 资源清单 + `game.json` 建议 + 构建报告。
|
|
120
|
+
- 项目级:`AGENTS.md` / `llms.txt` / `docs/03-module-map.md` 作为上下文索引。
|
|
121
|
+
|
|
122
|
+
建议把 `parseFailures.length === 0` 与 `missingAssets` 白名单作为 CI 门禁;把 `report()` 附在 bug issue 模板里,便于 AI 直接定位环境差异。
|
|
123
|
+
|
|
124
|
+
## 10.7 一次迭代的标准工作流
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
读 AGENTS.md / llms.txt / docs/03
|
|
128
|
+
↓
|
|
129
|
+
用 §10.2 三问确认边界 → 必要时写 ADR
|
|
130
|
+
↓
|
|
131
|
+
写失败测试(tests/*.test.ts,用 createMockWx)
|
|
132
|
+
↓
|
|
133
|
+
最小实现(只改 docs/03 指向的文件)
|
|
134
|
+
↓
|
|
135
|
+
npm run check(typecheck + 32+ 测试 + tsup)
|
|
136
|
+
↓
|
|
137
|
+
更新 docs/03 / docs/04 / docs/11 / CHANGELOG.md
|
|
138
|
+
↓
|
|
139
|
+
真机验收(docs/09 清单)→ 更新 docs/11 兼容矩阵
|
|
140
|
+
```
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# 11 · 兼容矩阵
|
|
2
|
+
|
|
3
|
+
> 状态说明:✅ 已验证 / 🟡 理论支持或单元测试覆盖,待真机 / ⚠️ 有限制 / ❌ 不支持。
|
|
4
|
+
> 每次发布前更新;真机验收清单见 [`docs/09`](./09-testing-and-release.md#97-真机验收清单发布前)。
|
|
5
|
+
|
|
6
|
+
## 11.1 three.js 版本
|
|
7
|
+
|
|
8
|
+
| three 版本 | 状态 | 说明 |
|
|
9
|
+
| --- | --- | --- |
|
|
10
|
+
| `>= 0.163.0`(r163+) | ✅ 目标区间 | r163 起 `WebGLRenderer` 要求 WebGL2,与本适配层默认一致 |
|
|
11
|
+
| `0.187.0` | 🟡 单元级 | 2026-11-08 npm 最新版;已按 Migration Guide 检查 `three/addons`、`outputColorSpace`、`setAnimationLoop`;待真机全量回归 |
|
|
12
|
+
| `0.151.0 ~ 0.162.x` | ⚠️ | 未针对 WebGL1 路径做专门适配,建议升级到 r163+ |
|
|
13
|
+
| `< 0.151.0` | ❌ | 不提供保证 |
|
|
14
|
+
| `three/webgpu` + TSL / NodeMaterial | ❌ | 小游戏无 WebGPU;插件默认告警,可选 `webgpu:'rewrite'` 仅适用于纯 WebGLRenderer 的简单场景 |
|
|
15
|
+
|
|
16
|
+
### 每次 three 升级需要复核的点
|
|
17
|
+
|
|
18
|
+
1. `DEFAULT_GLOBAL_NAMES`(`src/build/scope-rewrite.ts`)是否覆盖新增浏览器全局。
|
|
19
|
+
2. `patchElement` / `patchCanvas`(`src/core/element.ts`、`canvas.ts`)是否覆盖新增 DOM 属性。
|
|
20
|
+
3. import 路径:`three/addons/*` 与旧 `three/examples/jsm/*` 都要在插件 include 规则里。
|
|
21
|
+
4. `RGBELoader → HDRLoader`、`EffectComposer → PostProcessing` 等破坏性改名(r180+)。
|
|
22
|
+
5. `three/webgpu` 使用比例上升时,插件 `webgpu` 默认策略是否需要调整。
|
|
23
|
+
6. 用 `examples/` 的三个平台工程对 controls / loaders / postprocessing 类别做增量回归。
|
|
24
|
+
|
|
25
|
+
## 11.2 微信基础库 / 平台
|
|
26
|
+
|
|
27
|
+
| 能力 | 最低基础库 | 状态 | 依据 / 处理 |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| `wx.createCanvas` / `getContext('webgl2')` | — | ✅ | [渲染文档](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/render.html) |
|
|
30
|
+
| 唯一上屏画布规则 | — | ✅ | `getScreenCanvas()` 单次缓存 |
|
|
31
|
+
| `wx.createOffscreenCanvas` | 2.7.0(小程序)/ 小游戏同期 | ✅ | 能力探测与离屏画布;不可用时明确报错 |
|
|
32
|
+
| `wx.getWindowInfo` | 较新版本 | ✅ | 回退 `getSystemInfoSync` |
|
|
33
|
+
| `wx.onWindowResize` | — | 🟡 | 不可用时告警,需手动 `runtime.resize()` |
|
|
34
|
+
| `WXWebAssembly` | 2.13.0(Worker 内 2.15.0) | 🟡 | [官方文档](https://developers.weixin.qq.com/minigame/dev/guide/performance/perf-webassembly.html);插件按引用拷贝 wasm |
|
|
35
|
+
| `.wasm.br` Brotli | — | 🟡 | `assets.brotli: true` |
|
|
36
|
+
| Worker(分包) | 2.0.10 | 🟡 | 需 `wx.preDownloadSubpackage({packageType:'workers'})`;并发上限 1 |
|
|
37
|
+
| 分包加载 | 2.1.0 | 🟡 | `game.json` 建议由 manifest 生成 |
|
|
38
|
+
| iOS 高性能 / 高性能+ | 需后台开通 | 🟡 | `game.json` 的 `iOSHighPerformance` / `iOSHighPerformance+`;官方建议 WebGL2 场景开启高性能+ |
|
|
39
|
+
| `wx.triggerGC` | — | ✅ | 影响 image 创建路径判定 |
|
|
40
|
+
|
|
41
|
+
## 11.3 平台支持
|
|
42
|
+
|
|
43
|
+
| 平台 | 入口 | 状态 | 备注 |
|
|
44
|
+
| --- | --- | --- | --- |
|
|
45
|
+
| 微信小游戏 | `mini-three-adapter/wechat-game` | ✅ 单元级 | 自动订阅 `wx.onTouch*`;完整示例 |
|
|
46
|
+
| 微信小程序(`<canvas type="webgl2">`) | `mini-three-adapter/wechat-miniprogram` | 🟡 | 需 WXML 转发 `bindtouch*`;`selectorCtx` 传组件实例 |
|
|
47
|
+
| 浏览器 / H5 双端 | `mini-three-adapter/browser` | ✅ 单元级 | 真实 DOM 不被覆盖;可跑 Node 测试 |
|
|
48
|
+
| 其他小程序 / 小游戏平台 | 自定义 `PlatformBinding` | 🟡 框架就绪 | 按 [`docs/08`](./08-extension-guide.md#81-新增一个平台) 实现 |
|
|
49
|
+
| WebView 套壳 | 不在范围内 | ❌ | 本方案用于非 WebView 原生渲染 |
|
|
50
|
+
|
|
51
|
+
## 11.4 Web / DOM API 覆盖
|
|
52
|
+
|
|
53
|
+
| API | 提供方式 | 状态 |
|
|
54
|
+
| --- | --- | --- |
|
|
55
|
+
| `window` / `self` / `globalThis`(作用域内) | `MiniThreeScope` 自引用 | ✅ |
|
|
56
|
+
| `document.createElement('canvas' \| 'img')` | `createDocument` | ✅ |
|
|
57
|
+
| `document.createElementNS` / `body` / `visibilityState` | `createDocument` | ✅ |
|
|
58
|
+
| `HTMLCanvasElement` / `HTMLImageElement` / `HTMLElement` / `OffscreenCanvas` / `ImageData` / `DOMRect` 的 `instanceof` | `Symbol.hasInstance` 注册表 | ✅ |
|
|
59
|
+
| `Event` / `EventTarget` / `CustomEvent` / `PointerEvent` / `MouseEvent` / `MessageEvent` / `ProgressEvent` | `polyfills/event.ts` | ✅ |
|
|
60
|
+
| `Blob` / `URL.createObjectURL` / `URL.revokeObjectURL` | `mini-three-blob:` → `data:` | ✅ |
|
|
61
|
+
| `URL` 构造 / 相对路径解析 | `MiniURL` | ✅ |
|
|
62
|
+
| `TextEncoder` / `TextDecoder` / `atob` / `btoa` | `polyfills/text-encoding.ts` | ✅ |
|
|
63
|
+
| `fetch` / `XMLHttpRequest` / `AbortController` | `wx.request` 桥接 | 🟡 单元级,真机网络待验证 |
|
|
64
|
+
| `requestAnimationFrame` / `cancelAnimationFrame` | `FrameScheduler` | ✅ |
|
|
65
|
+
| `performance.now` | `wx.getPerformance` → `Date.now` 回退 | ✅ |
|
|
66
|
+
| `getComputedStyle` / `matchMedia` / `screen` / `navigator` | 轻量模拟 | ⚠️ 仅够 three 使用,非完整实现 |
|
|
67
|
+
| `createImageBitmap` | **故意为 `undefined`** | ✅ 让 three 走降级分支 |
|
|
68
|
+
| `FileReader` / `WebSocket` / `AudioContext` | 缺省或透传 | ⚠️ 业务需要时按 `docs/08` 扩展 |
|
|
69
|
+
| `Worker` / `WebAssembly` | 透传宿主全局(`WXWebAssembly`) | 🟡 |
|
|
70
|
+
| `ResizeObserver` | no-op | ⚠️ |
|
|
71
|
+
| 完整 DOM(布局、CSS、事件冒泡树) | 不提供 | ❌ 超出范围 |
|
|
72
|
+
|
|
73
|
+
## 11.5 场景回归记录
|
|
74
|
+
|
|
75
|
+
以 three 官方示例场景为主体建立回归集,用 `examples/` 的三个平台工程逐一接入验证。
|
|
76
|
+
|
|
77
|
+
| 类别 | 覆盖目标 | 状态 | 备注 |
|
|
78
|
+
| --- | --- | --- | --- |
|
|
79
|
+
| `controls_*` | OrbitControls / TrackballControls / TransformControls 的多指交互 | ⬜ 未回归 | 优先验证 pointerId、capture、`pointercancel` |
|
|
80
|
+
| `loader_*` | GLTF / DRACO / KTX2 / OBJ / FBX | ⬜ 未回归 | 需配置 decoder 路径与分包 |
|
|
81
|
+
| `postprocessing_*` | EffectComposer / bloom / SSAO | ⬜ 未回归 | 注意深度缓冲与 render target 尺寸 |
|
|
82
|
+
| `animation_*` / `physics_*` | 骨骼动画 / wasm 物理 | ⬜ 未回归 | 涉及 wasm 资源预下载 |
|
|
83
|
+
| 基础渲染 | `examples/wechat-minigame`、`wechat-miniprogram`、`h5` | ✅ 单元级 | 32 个 Vitest 用例覆盖画布、事件、作用域、插件 |
|
|
84
|
+
|
|
85
|
+
每回归一条,在本表追加:`场景 id | three 版本 | 基础库 | 设备 | 结果 | 失败原因 | 新增 polyfill`。
|
|
86
|
+
|
|
87
|
+
## 11.6 已知限制汇总
|
|
88
|
+
|
|
89
|
+
1. 不模拟 WebGPU;`three/webgpu` 项目需改用 WebGL 构建目标。
|
|
90
|
+
2. `createImageBitmap` 恒为 `undefined`,依赖该 API 的库需自带降级。
|
|
91
|
+
3. 不提供完整 DOM;DOM 密集型 UI 库应走 WebView 方案。
|
|
92
|
+
4. 插件默认只改写 `node_modules` 中的三方生态代码;应用代码里直接写 `window` 不会自动改写(可开 `includeUserCode`)。
|
|
93
|
+
5. 对象 URL 是 `mini-three-blob:` + `data:`,不是浏览器 `blob:`;若有库硬编码 `blob:` 前缀判断,需要适配。
|
|
94
|
+
6. Worker 分包、`.wasm.br`、iOS 高性能+ 需业务按 `mini-three-assets.json` 的 `gameJsonSuggestion` 自行配置,插件不直接改 `game.json`。
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# 文档总索引
|
|
2
|
+
|
|
3
|
+
本目录是 `mini-three-adapter` 的**唯一权威文档源**。文档按「人读」与「AI 读」两类组织,全部为纯 Markdown,可直接作为大模型上下文。
|
|
4
|
+
|
|
5
|
+
## 推荐阅读顺序
|
|
6
|
+
|
|
7
|
+
| 顺序 | 文档 | 读者 | 目的 |
|
|
8
|
+
| --- | --- | --- | --- |
|
|
9
|
+
| 0 | [`../AGENTS.md`](../AGENTS.md) | **AI** | 不变量、命令、修改边界、评审清单 |
|
|
10
|
+
| 1 | [`../llms.txt`](../llms.txt) | **AI** | 全仓库文件索引与摘要(llms.txt 标准) |
|
|
11
|
+
| 2 | [01 设计目标与技术约束](./01-design-principles.md) | 人 / AI | 项目定位、环境约束、技术选型、能力边界 |
|
|
12
|
+
| 3 | [02 架构设计](./02-architecture.md) | 人 / AI | 分层、数据流、不变量 |
|
|
13
|
+
| 4 | [03 模块地图](./03-module-map.md) | **AI** | 改哪个文件、会影响谁 |
|
|
14
|
+
| 5 | [04 API 参考](./04-api-reference.md) | 人 / AI | 全部导出与签名 |
|
|
15
|
+
| 6 | [05 构建插件](./05-build-plugin.md) | 人 / AI | 编译期行为 |
|
|
16
|
+
| 7 | [06 平台差异与坑](./06-platform-notes.md) | 人 | 平台能力与已知问题 |
|
|
17
|
+
| 8 | [07 接入与集成指南](./07-integration-guide.md) | 人 | 从零接入现有项目 |
|
|
18
|
+
| 9 | [08 扩展指南](./08-extension-guide.md) | 人 / AI | 新增平台 / polyfill / 资源规则 |
|
|
19
|
+
| 10 | [09 测试与发布](./09-testing-and-release.md) | 人 | 命令与 CI |
|
|
20
|
+
| 11 | [10 AI 协作手册](./10-ai-playbook.md) | **AI** | 提示词模板与迭代工作流 |
|
|
21
|
+
| 12 | [11 兼容矩阵](./11-compat-matrix.md) | 人 / AI | 版本与能力边界 |
|
|
22
|
+
| 13 | [ADR](./adr/README.md) | 人 / AI | 每条关键决策的动机与后果 |
|
|
23
|
+
|
|
24
|
+
## 文档维护约定
|
|
25
|
+
|
|
26
|
+
1. **先读 `AGENTS.md` 的「架构不变量」**,任何改动不得破坏其中任意一条。
|
|
27
|
+
2. **任何行为变更必须同时更新** `docs/03-module-map.md`(若涉及文件职责变化)、`docs/04-api-reference.md`(若涉及导出)、`CHANGELOG.md`,并补一个 `tests/**/*.test.ts` 用例。
|
|
28
|
+
3. 文档编号即阅读顺序;新增文档时按主题插入并在本表、`README.md` 文档表、`llms.txt` 索引中同步登记。
|
|
29
|
+
4. 文档只描述本项目自身的结构与行为,保持自洽;外部规范链接集中放在 `01` 与 `06` 的对应小节。
|
|
30
|
+
|
|
31
|
+
## 文档与代码的对应关系
|
|
32
|
+
|
|
33
|
+
| 想了解 | 先看 |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| 某个源文件该不该改 | [03 模块地图](./03-module-map.md) |
|
|
36
|
+
| 某个 API 怎么调用 | [04 API 参考](./04-api-reference.md) |
|
|
37
|
+
| 为什么生成 `__m3()` / 资产去哪了 | [05 构建插件](./05-build-plugin.md) |
|
|
38
|
+
| 为什么这样分层 | [02 架构设计](./02-architecture.md) 与 [ADR](./adr/README.md) |
|
|
39
|
+
| 怎么把适配层装进项目 | [07 接入与集成指南](./07-integration-guide.md) |
|
|
40
|
+
| 怎么发布到 npm | [09 测试与发布](./09-testing-and-release.md#95-发布到-npm) |
|
|
41
|
+
| 用 AI 改代码时怎么提问 | [10 AI 协作手册](./10-ai-playbook.md) |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# ADR-0001 · 作用域化的浏览器环境 shim
|
|
2
|
+
|
|
3
|
+
- 状态:Accepted
|
|
4
|
+
- 日期:2026-11-08
|
|
5
|
+
- 影响模块:`src/scope.ts`、`src/core/runtime.ts`、`src/build/scope-rewrite.ts`、`src/build/vite.ts`
|
|
6
|
+
|
|
7
|
+
## 背景
|
|
8
|
+
|
|
9
|
+
小游戏运行时没有 DOM/BOM,three 及其 addons 却会读取 `window`、`document`、`Image`、`URL` 等浏览器全局。要让这些代码工作,就必须有一个地方提供这些对象。
|
|
10
|
+
|
|
11
|
+
如果把 shim 直接挂到 `globalThis`,或者约定一个固定名字的全局容器,会带来几个结构性问题:H5 双端构建会与真实 `window` 冲突;同一进程里无法并存两个独立 runtime;单元测试无法干净还原;全局名靠约定,出错时难以定位。此外,三方模块中的全局引用是在模块求值时发生的,作用域何时可用必须是可以推理的,而不能依赖 import 的隐式副作用。
|
|
12
|
+
|
|
13
|
+
## 决策
|
|
14
|
+
|
|
15
|
+
1. 所有 shim 只存在于一个显式的 `MiniThreeScope` 对象里,`window === self === globalThis === scope`。
|
|
16
|
+
2. `setActiveScope(scope)` 返回 disposer;`getActiveScope()` 供构建插件注入的 `__m3()` 使用,且每次访问都返回**当前**作用域,支持运行时替换。
|
|
17
|
+
3. 三方模块通过构建插件改写为 `__m3().window`;应用代码不受影响。
|
|
18
|
+
4. `installGlobals(scope)` 是**唯一**写 `globalThis` 的地方,必须显式调用、返回精确还原 descriptor 的 disposer,默认关闭。
|
|
19
|
+
5. 未创建 runtime 时 `getActiveScope()` 返回一个占位对象:`typeof x.window` 仍为 `'object'`(满足 three 特性检测),但真正取属性时抛出带指引的错误。
|
|
20
|
+
|
|
21
|
+
## 理由
|
|
22
|
+
|
|
23
|
+
- 可逆性让测试、热更新、多实例、H5 双端都成为可能。
|
|
24
|
+
- 显式生命周期让「作用域何时可用」成为可推理的问题。
|
|
25
|
+
- 惰性读取让作用域可以在不重新构建三方模块的前提下被替换。
|
|
26
|
+
|
|
27
|
+
## 后果
|
|
28
|
+
|
|
29
|
+
- 正面:H5 双端同源、可 `dispose()`、可注入 mock、可观测。
|
|
30
|
+
- 负面:**必须先创建 runtime 再让 three 模块求值**,因此入口必须用动态 `import('./scene.js')`;这是一个需要写进文档与示例的约束(见 `docs/06` §6.2)。
|
|
31
|
+
- 风险:若某个三方库在模块顶层就把 `window.innerWidth` 缓存下来,动态 import 顺序错误会得到占位值——占位作用域会抛明确错误而不是静默返回错误值。
|
|
32
|
+
|
|
33
|
+
## 被否决的备选方案
|
|
34
|
+
|
|
35
|
+
- 直接 `globalThis.window = ...`:简单但不可逆,否决。
|
|
36
|
+
- 每个 runtime 一个 Proxy 拦截全局:性能与兼容性(JSC)风险,且仍要写全局,否决。
|
|
37
|
+
- 让用户在业务代码里手动 `import { scope }`:侵入太大,三方库改不到,否决。
|
|
38
|
+
|
|
39
|
+
## 验证方式
|
|
40
|
+
|
|
41
|
+
`tests/runtime.test.ts`:「populates a scoped environment without polluting globalThis」「installGlobals is reversible」;`tests/scope-rewrite.test.ts`:注入的 import 与 `typeof` 行为。
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# ADR-0002 · 单一 `createRuntime()` / `MiniThreeRuntime` 生命周期
|
|
2
|
+
|
|
3
|
+
- 状态:Accepted
|
|
4
|
+
- 日期:2026-11-08
|
|
5
|
+
- 影响模块:`src/core/platform.ts`、`src/core/runtime.ts`、`src/platforms/*`、`src/index.ts`
|
|
6
|
+
|
|
7
|
+
## 背景
|
|
8
|
+
|
|
9
|
+
小游戏与小程序的画布获取方式本质不同:前者可以同步拿到唯一的上屏画布,后者需要异步查询节点。如果按平台分别暴露门面,业务代码就要写两套调用方式,订阅、rAF、全局注入也容易散落在各处,缺少统一的销毁入口。
|
|
10
|
+
|
|
11
|
+
需要一个装配点,把这些差异吸收在内部,对业务只暴露一个对象和一种生命周期。
|
|
12
|
+
|
|
13
|
+
## 决策
|
|
14
|
+
|
|
15
|
+
1. 定义结构化契约 `PlatformBinding`(不是抽象基类),把平台差异收敛为一组字段/方法。
|
|
16
|
+
2. 只有 `createRuntime(platform, options)` 一个装配入口,返回唯一的 `MiniThreeRuntime`。
|
|
17
|
+
3. 三个平台快捷函数(`createWeChatGameRuntime` / `createWeChatMiniProgramRuntime` / `createBrowserRuntime`)只是「构造 binding + 调 createRuntime」的语法糖,全部返回 `Promise<MiniThreeRuntime>`。
|
|
18
|
+
4. 小程序异步查询、小游戏同步画布的差异被 `await binding.getCanvasRect()` 吸收;对外只有 `await runtime.resize()` 一种写法。
|
|
19
|
+
5. 所有订阅、定时器、全局注入登记到 `disposers`,`runtime.dispose()` 逆序执行;`runtime.on('dispose')` 供业务释放 three 资源。
|
|
20
|
+
|
|
21
|
+
## 理由
|
|
22
|
+
|
|
23
|
+
- 用组合(结构化接口)替代继承,平台实现不必继承基类、不必暴露内部装配状态。
|
|
24
|
+
- 单一生命周期使「有没有泄漏」变成可测试命题,也让 AI 迭代时只有一个心智模型。
|
|
25
|
+
- 统一异步 API 消除了按平台分支带来的文档、类型与接入成本。
|
|
26
|
+
|
|
27
|
+
## 后果
|
|
28
|
+
|
|
29
|
+
- 正面:业务代码三端一致;`dispose()` 可验证;新增平台只需实现 `PlatformBinding`。
|
|
30
|
+
- 负面:小游戏本来可以同步启动,现在必须 `await` 一次(代价可忽略,且启动时本来就要读窗口信息)。
|
|
31
|
+
- 风险:平台实现若忘记把某个监听加入 `dispose()`,仍会泄漏——由 `docs/08` 评审清单与测试约束。
|
|
32
|
+
|
|
33
|
+
## 被否决的备选方案
|
|
34
|
+
|
|
35
|
+
- 按平台分别暴露门面再包一层兼容:把复杂度永久留在 API 里,否决。
|
|
36
|
+
- 平台抽象基类 + 条件类型:需要继承、难以组合、类型可读性差,否决。
|
|
37
|
+
|
|
38
|
+
## 验证方式
|
|
39
|
+
|
|
40
|
+
`tests/runtime.test.ts`:「emits resize and dispose events, and fully tears down」断言 `wx.__touch.start` 被清空、`disposed === true`。
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# ADR-0003 · 用 Babel AST 作用域分析重写三方模块全局引用
|
|
2
|
+
|
|
3
|
+
- 状态:Accepted
|
|
4
|
+
- 日期:2026-11-08
|
|
5
|
+
- 影响模块:`src/build/scope-rewrite.ts`、`src/build/plugin-core.ts`、`src/build/assets.ts`
|
|
6
|
+
|
|
7
|
+
## 背景
|
|
8
|
+
|
|
9
|
+
「不 fork three」的前提是能在构建期把三方代码里的浏览器全局访问重定向到作用域对象。文本或近似作用域替换在以下场景会误伤:
|
|
10
|
+
|
|
11
|
+
```js
|
|
12
|
+
function f(window) { return window.innerWidth; } // 局部同名
|
|
13
|
+
const o = { window: 1 }; // 对象键
|
|
14
|
+
foo.window; // 成员属性
|
|
15
|
+
if (typeof window !== 'undefined') { ... } // 特性检测
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
随着 three 及其生态(three-stdlib、r3f、tresjs)代码量增长,误伤概率与版本升级成本都很高。改写必须建立在真实的词法作用域信息之上。
|
|
19
|
+
|
|
20
|
+
## 决策
|
|
21
|
+
|
|
22
|
+
1. 用 `@babel/parser`(`sourceType: 'unambiguous'`,启用 TS/JSX 插件)解析每个候选模块。
|
|
23
|
+
2. 用 `@babel/traverse` 的 `ReferencedIdentifier` visitor,只处理**引用位置**的标识符。
|
|
24
|
+
3. 通过 `path.scope.hasBinding(name, true)` 判定是否为自由变量(第二参数屏蔽 Babel 内建全局表,否则 `window` 会被当成 binding 而漏改)。
|
|
25
|
+
4. 排除非计算的对象键、类成员键、成员表达式属性。
|
|
26
|
+
5. 用 `MagicString.overwrite` 精确替换并 `prepend` 一行 `import { getActiveScope as __m3 } from 'mini-three-adapter/scope';`,保留 sourcemap。
|
|
27
|
+
6. `globalThis` 故意不在默认清单(three 用它挂调试钩子)。
|
|
28
|
+
7. 解析失败 → 记录 `parseFailures`、告警、**原样返回**,绝不产出半改写代码。
|
|
29
|
+
|
|
30
|
+
## 理由
|
|
31
|
+
|
|
32
|
+
- 作用域正确性由 Babel 保证,不用自己实现词法作用域。
|
|
33
|
+
- 精确 rewrite + sourcemap 便于调试与 CI 统计(`BuildReport`)。
|
|
34
|
+
- 把「三方代码」与「应用代码」的边界显式化为 `include(id)`,可审计。
|
|
35
|
+
|
|
36
|
+
## 后果
|
|
37
|
+
|
|
38
|
+
- 正面:局部遮蔽、`typeof`、对象键全部正确;支持 TS/JSX;构建报告可观测。
|
|
39
|
+
- 负面:构建期新增 `@babel/parser` / `@babel/traverse` / `magic-string` 三个依赖(**只在 Node 侧,不进小游戏包**);解析有少量构建耗时。
|
|
40
|
+
- 风险:Vite 预打包会把 three 变成一个不透明 blob → `vite.ts` 的 `config()` 显式 `optimizeDeps.exclude`;`.vite/deps/three*` 作为兜底 include。
|
|
41
|
+
- 风险:某模块用了 Babel 不支持的语法 → 跳过并告警,需人工加插件或 `exclude`。
|
|
42
|
+
|
|
43
|
+
## 被否决的备选方案
|
|
44
|
+
|
|
45
|
+
- 正则 / 字符串替换:正确性无法保证,否决。
|
|
46
|
+
- Rollup `attachScopes` + 自定义遍历:能拿到作用域但要自己处理所有节点类型,维护成本高,否决。
|
|
47
|
+
- 运行时 `with` / Proxy 作用域:性能与严格模式限制,否决。
|
|
48
|
+
|
|
49
|
+
## 验证方式
|
|
50
|
+
|
|
51
|
+
`tests/scope-rewrite.test.ts` 8 例:自由变量、局部遮蔽、对象键/成员属性、`typeof`、import/export 不改写、无命中返回 null、自定义访问器、默认清单不含 `globalThis`。
|