越界发现,记录于 #3537(给 runner 补 api 查询参数文档)期间。未在该 PR 中顺手修改 —— 该 PR 的文件面虽然含 packages/runner/README.md,但改动范围锁在「元数据加载」这一主题(原 ## Schema Loading 一节),下面这三处是另外的能力面,属另一件事。与 #3533 同源:文档描述实现里不存在的东西。
事实(均对 origin/main 复核)
1. ## Programmatic Usage —— createRunner() 不存在,且这个包根本没有库入口。
README:41-49 教读者
import { createRunner } from '@object-ui/runner';
const runner = createRunner({ schema: mySchema, plugins: ['kanban', 'charts'], theme: 'light' });
runner.mount('#app');
- 全仓
createRunner 只出现在这两行 README 里:
$ grep -rn "createRunner" --include=*.ts --include=*.tsx --include=*.md . → 仅 packages/runner/README.md:41,43
packages/runner/package.json 没有 main / module / exports / types 任何一个字段(实测 undefined),files 只有 ["dist","README.md","CHANGELOG.md","LICENSE"]。也就是说 import ... from '@object-ui/runner' 无从解析 —— 这个包是一个 Vite 应用(index.html + src/main.tsx),不是库。
- 同一节上方的
## Installation(pnpm add @object-ui/runner)因此也是误导:装了也没有可 import 的入口。
2. ## Configuration —— runner.config.js 不存在。
README:84-95 教读者建 runner.config.js 配 port / host / plugins / theme。全仓 runner.config 只出现在这一行 README 里(同一条 grep,零代码引用)。runner 的实际配置面是 vite.config.ts(端口/别名)和 URL 查询参数 api(元数据基址,见 #3537 与 PR 中新增的文档),没有任何一段代码读 runner.config.js。
3. ## API Reference 的链接 404。
README:151 指向 https://www.objectui.org/docs/runner,但该页不存在 —— 文档页是 content/docs/utilities/runner.mdx,路由 /docs/utilities/runner(同一 README 底部的 ## Links 一节写的就是正确的那条)。注意 packages/*/README.md 不在 scripts/check-doc-links.mjs 的 SCAN_ROOTS(只有 content/docs、examples、根 README.md),所以这条链接不会被门禁发现,只能人工核。
建议
按 #3533 的口径:文档不许描述不存在的能力。1 与 2 整节删除(或改写为 runner 真实的用法:它是一个跑起来的应用,不是可 import 的库);3 把链接改成 /docs/utilities/runner。
Generated by Claude Code
越界发现,记录于 #3537(给 runner 补
api查询参数文档)期间。未在该 PR 中顺手修改 —— 该 PR 的文件面虽然含packages/runner/README.md,但改动范围锁在「元数据加载」这一主题(原## Schema Loading一节),下面这三处是另外的能力面,属另一件事。与 #3533 同源:文档描述实现里不存在的东西。事实(均对
origin/main复核)1.
## Programmatic Usage——createRunner()不存在,且这个包根本没有库入口。README:41-49 教读者
createRunner只出现在这两行 README 里:$ grep -rn "createRunner" --include=*.ts --include=*.tsx --include=*.md .→ 仅packages/runner/README.md:41,43packages/runner/package.json没有main/module/exports/types任何一个字段(实测undefined),files只有["dist","README.md","CHANGELOG.md","LICENSE"]。也就是说import ... from '@object-ui/runner'无从解析 —— 这个包是一个 Vite 应用(index.html+src/main.tsx),不是库。## Installation(pnpm add @object-ui/runner)因此也是误导:装了也没有可 import 的入口。2.
## Configuration——runner.config.js不存在。README:84-95 教读者建
runner.config.js配port/host/plugins/theme。全仓runner.config只出现在这一行 README 里(同一条 grep,零代码引用)。runner 的实际配置面是vite.config.ts(端口/别名)和 URL 查询参数api(元数据基址,见 #3537 与 PR 中新增的文档),没有任何一段代码读runner.config.js。3.
## API Reference的链接 404。README:151 指向
https://www.objectui.org/docs/runner,但该页不存在 —— 文档页是content/docs/utilities/runner.mdx,路由/docs/utilities/runner(同一 README 底部的## Links一节写的就是正确的那条)。注意packages/*/README.md不在scripts/check-doc-links.mjs的SCAN_ROOTS(只有content/docs、examples、根README.md),所以这条链接不会被门禁发现,只能人工核。建议
按 #3533 的口径:文档不许描述不存在的能力。1 与 2 整节删除(或改写为 runner 真实的用法:它是一个跑起来的应用,不是可 import 的库);3 把链接改成
/docs/utilities/runner。Generated by Claude Code