Skip to content

content/docs/utilities/runner.mdx 三处结构性陈述与实现不符:src/schemas 目录、「内置示例 schema」、Package Information 的版本与发布状态 #3577

Description

@yinlianghui

越界发现,记录于 #3537(给同一页补 api 查询参数文档)期间。未在该 PR 中顺手修改 —— 该 PR 只在 ## Configuration 下新增一节,不改这三处;它们是独立的陈述面,合并进去会让那个 PR 变成「顺手大扫除」。与 #3533 同源。

事实(均对 origin/main 复核)

1. ## Directory Structure 画的目录不存在。 文档给出

packages/runner/
├── src/
│   ├── App.tsx
│   ├── main.tsx
│   ├── schemas/             # dashboard.json / kanban.json / charts.json
│   └── components/
├── public/

实测 packages/runner/src 下只有:App.tsxLayoutRenderer.tsxmain.tsxindex.csslib/MetadataLoader.tslib/mockDataSource.ts__tests__/plugin-integration.test.ts没有 schemas/没有 components/,包根也没有 public/。真实的元数据来源是 src/app-data/(gitignore,新检出为空,见 PR #3537 新增的 "Metadata Loading" 一节)。

2. ## What's Included### Example Schemas 说包里带了示例 schema。 文档列了 Dashboard / 数据表格 / 表单校验 / Kanban / 图表 / 日历 / 时间线七类「Runner 包含的示例 schema」。实际这个包一个 schema 文件都不带 —— 承载它们的 src/app-data/packages/runner/.gitignore:1 里,仓库中不存在;缺该目录时 LocalBundleLoader 的三个 import.meta.glob 编译为 {}(实测:vite dev server 返回的转译结果里 appGlob/pagesGlob/rootGlob 均为 Object.assign({})),/ 渲染的是内置兜底文案 No index page found.

3. ## Package Information 的版本与发布状态都过期。 文档写

**Version:** 0.3.1
**Type:** Application (not published to npm)

packages/runner/package.json 实测:"version": "17.3.0""private": false"publishConfig": { "access": "public" },且 .changeset/config.jsonfixed 组里含 @object-ui/runner(随 39 包一起发)。README 底部也挂着 npm 包链接。手写版本号本就会持续漂移,建议直接删掉 Version 行而不是改成 17.3.0。

备注

第 2 条与 #3537 的 PR 有轻微张力:该 PR 新增的一节如实说明「src/app-data/ 由你自己提供,缺失时什么都加载不到」,而本页上方仍写着「Runner 包含这些示例 schema」。两处并存时以新增节为准,本单收尾。


Generated by Claude Code

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationpm:dispatched

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions