@kevlns/u-cli-mod 0.2.3 → 0.2.4
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 +7 -5
- package/README.md +16 -15
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
- `u-cli-mod setup <project>` - CLI + 适配包一键就绪(推荐首次入口)
|
|
14
14
|
- `u-cli-mod pipeline install <project> --dry-run` - 安装预览(不写入工程)
|
|
15
15
|
- `u-cli-mod pipeline install <project>` - 事务式安装适配包(自动备份/回滚/receipt)
|
|
16
|
-
- `u-cli-mod exec <project> -- <pipeline-args>` - 执行 Pipeline 命令(工具统一绑定 `--project-path
|
|
17
|
-
- Pipeline 命令全集见文末「Pipeline 工具清单」(适配版 `com.unity.pipeline` 共 154 个命令,按领域分组)
|
|
18
|
-
- `u-cli-mod exec <project> [--wait <秒>] -- <pipeline-args>` - 长任务默认 5s 后让出控制权,结果用对应的 `command <name>_status` 轮询
|
|
16
|
+
- `u-cli-mod exec <project> [--wait <秒>] -- <pipeline-args>` - 执行 Pipeline 命令(工具统一绑定 `--project-path`);长任务(`run_tests`)默认 5s 后让出控制权,结果用对应的 `command <name>_status` 轮询
|
|
19
17
|
- `u-cli-mod routes` / `u-cli-mod cache clean` - 路由表 / 缓存清理
|
|
20
18
|
|
|
19
|
+
Pipeline 命令全集见文末「Pipeline 工具清单」(适配版 `com.unity.pipeline`,按领域分组)。
|
|
20
|
+
|
|
21
21
|
## 使用规范(Agent 必须遵守)
|
|
22
22
|
|
|
23
23
|
1. **首次对某工程执行 `exec` 前**,必须检查 `doctor` 的 `cli.state="valid"`、`pipeline.state="current"` 且 `pipeline.installed=true`。`doctor` 退出成功仅表示诊断完成,不代表工程已就绪;`pipeline.present=true` 也只表示包存在。`missing` 时先跑 `setup`;`outdated`/`invalid` 时先关闭目标 Editor,再通过 `pipeline install <project> --force` 备份并更新。升级 npm 包不会自动更新工程内适配包,不要直接 `exec`。
|
|
@@ -27,8 +27,8 @@
|
|
|
27
27
|
5. **版本路由是精确匹配**(`m_EditorVersion` + revision 同时一致),没有"就近版本"回退;工程版本不在路由表内时如实报告支持列表,不得猜测、不得改写 `ProjectVersion.txt`。
|
|
28
28
|
6. `exec` 每次调用前都会重新校验 CLI 哈希(防篡改),属正常行为;校验失败按提示跑 `u-cli-mod cli install --force` 修复即可。
|
|
29
29
|
7. **读取 Editor 当前 Console 首选 `command read_console`**,`get_console_logs` 是兼容别名;`command console` 读取回调捕获流,适合 `since`/cursor 跟随,但不能代替原生 Console 快照。工具必须经 `command <名>` 调用。若实际 schema 中缺少 `read_console`,先检查 `doctor` 的 `patchVersion`/`installedPatchVersion` 和 `state`,不要将其误认成 `console` 的别名。
|
|
30
|
+
8. **全量测试必须走 `--async_tests`**:Unity CLI 对同步命令有 30 秒硬性等待上限(`--timeout` 无法延长),同步 `run_tests` 全量必然超时且不入 `test_status` 跟踪。用法:`run_tests --mode EditMode --async_tests`(立即返回)→ 轮询 `test_status` 至 `completed` 拿完整 Summary;小范围用 `--filter` 缩到单命名空间/类,可直接同步等待拿 Summary。
|
|
30
31
|
|
|
31
|
-
8. **全量测试必须走 `--async_tests`**:Unity CLI 对同步命令有 30 秒硬性等待上限(`--timeout` 无法延长),同步 `run_tests` 全量必然超时且不入 `test_status` 跟踪。全量:`run_tests --mode EditMode --async_tests`(立即返回)→ 轮询 `test_status` 至 `completed` 拿完整 Summary;小范围用 `--filter` 缩到单命名空间/类,可直接同步等待拿 Summary。
|
|
32
32
|
## 典型流程
|
|
33
33
|
|
|
34
34
|
```bash
|
|
@@ -40,7 +40,9 @@ u-cli-mod exec <project> -- command run_tests --mode EditMode --async_tests
|
|
|
40
40
|
u-cli-mod exec <project> -- command read_console --types error,warning --count 100
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
### doctor 输出要点
|
|
44
|
+
|
|
45
|
+
`doctor.pipeline` 的 `patchVersion` 为当前路由要求的补丁版本,`installedPatchVersion` 为 receipt 记录的版本(缺失或未知为 null);`state` 为 `missing | outdated | invalid | current`。完整 expected-tree 校验通过即返回 `installed=true` / `current`,receipt 缺失或陈旧不触发重装。`verification` 列出内容不匹配、校验错误及仅行尾差异的文件。已安装 UTF-8 文本允许 LF/CRLF 等价,其他内容及二进制仍严格校验;生成源与 staging 保持字节级校验,新生成文本统一 LF。`sourceReady=false` 仅表示生成缓存需重建,不代表已安装包失效。
|
|
44
46
|
|
|
45
47
|
## Pipeline 工具清单
|
|
46
48
|
|
package/README.md
CHANGED
|
@@ -106,9 +106,9 @@ u-cli-mod cache clean
|
|
|
106
106
|
5. 事务式安装到 `Packages/com.unity.pipeline`:staging → 校验 → 备份 → 替换 → 再校验 → receipt;任一步失败自动回滚。运行中的 Unity Editor 会 fail-closed 阻止安装。
|
|
107
107
|
6. `exec` 每次调用前重新校验 CLI 哈希,并**禁止任何 `--project-path` 变体覆盖目标工程**。
|
|
108
108
|
|
|
109
|
-
>
|
|
109
|
+
> **缓存目录说明**:用户缓存固定为 `%LOCALAPPDATA%\editor-pipeline-cli`,工程内的安装事务目录固定为 `Library/editor-pipeline-cli`。两个目录名是缓存与 receipt 契约的一部分,不随 npm 包名(`@kevlns/u-cli-mod`)变化;改名会使既有缓存与 receipt 失效。
|
|
110
110
|
|
|
111
|
-
##
|
|
111
|
+
## 包内容与分发边界
|
|
112
112
|
|
|
113
113
|
- ✅ 只包含本工具自己的 TypeScript 代码、版本路由元数据与哈希清单。
|
|
114
114
|
- ✅ Unity CLI 与 `com.unity.pipeline` 在**运行时**从 Unity 官方地址下载到**用户缓存**。
|
|
@@ -121,9 +121,9 @@ u-cli-mod cache clean
|
|
|
121
121
|
|
|
122
122
|
```bash
|
|
123
123
|
npm run check # build + lint + vitest 测试 + pack guard
|
|
124
|
+
```
|
|
124
125
|
|
|
125
126
|
> 发版除 `npm version` 外,还需同步 tests/scripts 中的版本断言(`cli.test.ts`、`vcli-manifest.test.ts`、`pack-guard.mjs`、`test-package-install.mjs`):grep 旧版本号应为零,再打 tag。
|
|
126
|
-
```
|
|
127
127
|
|
|
128
128
|
`pack:guard` 会执行真实 `npm pack`(含文件清单校验),断言发布包:
|
|
129
129
|
|
|
@@ -139,7 +139,7 @@ npm run check # build + lint + vitest 测试 + pack guard
|
|
|
139
139
|
|
|
140
140
|
### v-cli 插件清单
|
|
141
141
|
|
|
142
|
-
`v-cli.plugin.json` 随包发布(`package.json` 中 `vCli.manifest` 指向),声明 v-cli 命令 `unity`(平台 win32)与全部公共命令路径、参数、选项、输出与副作用元数据。`tests/vcli-manifest.test.ts` 以 `buildProgram()` 为行为源校验清单:命令树、参数、选项(flags 与描述)、usage
|
|
142
|
+
`v-cli.plugin.json` 随包发布(`package.json` 中 `vCli.manifest` 指向),声明 v-cli 命令 `unity`(平台 win32)与全部公共命令路径、参数、选项、输出与副作用元数据。`tests/vcli-manifest.test.ts` 以 `buildProgram()` 为行为源校验清单:命令树、参数、选项(flags 与描述)、usage 逐项一致;同一测试还把 AGENTS.md 的 154 条 Pipeline 命令目录与清单逐条互锁——两处任一未同步都会失败。
|
|
143
143
|
|
|
144
144
|
### 本地 tarball 安装矩阵(三模式验证)
|
|
145
145
|
|
|
@@ -147,7 +147,7 @@ npm run check # build + lint + vitest 测试 + pack guard
|
|
|
147
147
|
npm run test:package
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
构建真实 tgz,并在本地验证三种消费方式:工程 devDependency(`node_modules/.bin`)、带临时 `--prefix` 的全局安装、`npx --package <本地tgz>`;每种都执行 `u-cli-mod --version` 与 `u-cli-mod routes`。**不会**向任何 registry
|
|
150
|
+
构建真实 tgz,并在本地验证三种消费方式:工程 devDependency(`node_modules/.bin`)、带临时 `--prefix` 的全局安装、`npx --package <本地tgz>`;每种都执行 `u-cli-mod --version` 与 `u-cli-mod routes`。**不会**向任何 registry 发布。报告:`C:/tmp/u-cli-mod-package-test-report.json`(可用 `EPC_PKG_REPORT` 覆盖)。
|
|
151
151
|
|
|
152
152
|
### 自托管 Runner 与 Unity E2E
|
|
153
153
|
|
|
@@ -157,30 +157,30 @@ npm run e2e:windows # 完整 Unity E2E(真实下载/转换/编译/命
|
|
|
157
157
|
```
|
|
158
158
|
|
|
159
159
|
- `preflight:runner` 只读,不下载/注册 Runner;结果 JSON 输出到 stdout。
|
|
160
|
-
- `e2e:windows`
|
|
160
|
+
- `e2e:windows` 默认使用隔离缓存(设 `EPC_E2E_FRESH_CACHE=0` 可复用真实用户缓存),在 `C:/tmp/u-cli-mod-e2e/` 下创建独立临时工程,全部结束后杀掉它启动的所有 Unity 进程并清理临时工程;报告写入 `C:/tmp/u-cli-mod-e2e-report.json`(分别可用 `EPC_E2E_ROOT`、`EPC_E2E_REPORT` 覆盖)。
|
|
161
161
|
- 验收指标:200 次只读调用 100% 成功并记录 P50/P95、`read_console` 原生 Console 历史读取与统一清理、20 轮资源修改、5 次 Domain Reload 首次恢复、强杀重启恢复、双工程显式路由 60 次无误选、运行中 Editor 防护与 `--project-path` 覆盖拒绝。
|
|
162
162
|
|
|
163
163
|
详细说明见 `docs/SELF_HOSTED_RUNNER.md`。
|
|
164
164
|
|
|
165
165
|
### GitHub Actions
|
|
166
166
|
|
|
167
|
-
- `.github/workflows/ci.yml`:hosted windows runner 上跑 `npm ci` + `npm run check` + `npm audit --omit=dev` +
|
|
167
|
+
- `.github/workflows/ci.yml`:hosted windows runner 上跑 `npm ci` + `npm run check` + `npm audit --omit=dev` + 违禁产物扩展名扫描;push/PR 触发。
|
|
168
168
|
- `.github/workflows/e2e-windows.yml`:**self-hosted** runner(标签 `self-hosted/windows/unity-2022.3.62f3c1`)上跑 Unity E2E;仅 `workflow_dispatch` 与受保护 `v*` tag 触发,不跑 pull_request,不发布;权限最小化(contents: read);产物 `u-cli-mod-e2e-report`。
|
|
169
|
+
- `.github/workflows/publish.yml`:`v*` tag 触发,GitHub 托管 runner 上以 OIDC Trusted Publisher 短期凭证发布到 npm,不保存长期 NPM_TOKEN。
|
|
169
170
|
|
|
170
171
|
## Routes
|
|
171
172
|
|
|
172
173
|
| Editor | Revision | CLI | Pipeline | 状态 |
|
|
173
174
|
|---|---|---|---|---|
|
|
174
175
|
| `2022.3.62f3c1` | `1623fc0bbb97` | `1.0.0-beta.2` | `0.5.0-exp.1`(适配版) | 已验证(非官方移植) |
|
|
175
|
-
| `2022.3.59f1c1` | `6f0f5d6fe989` | `1.0.0-beta.2` | `0.5.0-exp.1`(适配版) |
|
|
176
|
+
| `2022.3.59f1c1` | `6f0f5d6fe989` | `1.0.0-beta.2` | `0.5.0-exp.1`(适配版) | 已验证(非官方移植;与 62f3 共用同一上游 tgz 与补丁规则,适配载荷逐字节一致;2022.3.59f1c1 真机回归通过) |
|
|
176
177
|
|
|
177
|
-
新增 Editor
|
|
178
|
+
新增 Editor 版本要求:添加 `routes/<版本>.json` 与 `routes/expected-tree/<版本>.json`、对应转换模板与补丁规则,并在该版本 Unity 上完成编译与回归测试;相近版本不得复用既有路由。
|
|
178
179
|
|
|
179
180
|
## 目录
|
|
180
181
|
|
|
181
182
|
```text
|
|
182
|
-
routes/
|
|
183
|
-
routes/expected-tree/ 385 文件 SHA-256 清单(含 Tests.meta)
|
|
183
|
+
routes/ 精确版本路由;expected-tree/ 子目录为 385 文件 SHA-256 清单(含 Tests.meta)
|
|
184
184
|
templates/ Unity 生成的 .meta 模板(数据,非 Unity 源码)
|
|
185
185
|
AGENTS.md AI Agent 使用规范(场景/规范/速览)
|
|
186
186
|
src/ TypeScript 实现
|
|
@@ -193,11 +193,12 @@ scripts/ pack-guard / preflight-runner / e2e-windows / test-package-inst
|
|
|
193
193
|
|
|
194
194
|
kevlns 工具家族共享同一套发布约定(tag 驱动、CI 护栏、MIT)。
|
|
195
195
|
|
|
196
|
-
| Package | Purpose |
|
|
196
|
+
| Package | Purpose | Version |
|
|
197
197
|
| --- | --- | --- |
|
|
198
|
-
| [`v-cli`](https://github.com/kevlns/v-cli) | 个人工具箱 CLI | v0.2.
|
|
198
|
+
| [`v-cli`](https://github.com/kevlns/v-cli) | 个人工具箱 CLI | v0.2.14 |
|
|
199
199
|
| [`xlmerge`](https://github.com/kevlns/xlmerge) | Git 中 .xlsx/.xlsm 冲突可视化解决工具 | v2.0.0 |
|
|
200
200
|
| [`u-cli-mod`](https://github.com/kevlns/u-cli-mod) | Unity 精确版本路由 + CLI + pipeline 包(Windows-first,本仓库) | v0.2.3 |
|
|
201
|
+
| [`figma-to-uprefab`](https://github.com/kevlns/figma-to-uprefab) | Figma 导出、契约校验与 Unity UGUI staging Prefab 构建 | v0.1.1 |
|
|
201
202
|
|
|
202
203
|
## Compatibility
|
|
203
204
|
|
|
@@ -210,14 +211,14 @@ kevlns 工具家族共享同一套发布约定(tag 驱动、CI 护栏、MIT)
|
|
|
210
211
|
|
|
211
212
|
```bash
|
|
212
213
|
npm ci
|
|
213
|
-
npm run check # build + lint +
|
|
214
|
+
npm run check # build + lint + vitest 测试 + pack guard
|
|
214
215
|
```
|
|
215
216
|
|
|
216
217
|
For bugs and feature requests, use [GitHub Issues](https://github.com/kevlns/u-cli-mod/issues).
|
|
217
218
|
|
|
218
219
|
## License
|
|
219
220
|
|
|
220
|
-
本工具代码为 MIT(见 LICENSE)。运行时下载的 Unity CLI 与 `com.unity.pipeline` 归其各自的 Unity 许可(如 Unity Package Distribution License
|
|
221
|
+
本工具代码为 MIT(见 LICENSE)。运行时下载的 Unity CLI 与 `com.unity.pipeline` 归其各自的 Unity 许可(如 Unity Package Distribution License)约束,不在本仓库/包内分发。
|
|
221
222
|
|
|
222
223
|
<div align="center">
|
|
223
224
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kevlns/u-cli-mod",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "u-cli-mod: pin exact Unity Editor version routes and install the adapted com.unity.pipeline package for Unity 2022 (Windows-first). Downloads Unity assets at runtime into the user cache; the package itself contains no Unity binaries or package source. Not an official Unity project.",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|