Skip to content

plugin-dashboard README 的 TypeScript 一节导入 DashboardSchema / MetricCardSchema,两个名字在全仓都不存在 #5015

Description

@yinlianghui

发现于 #5002 的实施(plugin-map README 重写)。Filed unassigned, not claiming.

现象

packages/plugin-dashboard/README.md:321:

importtype{DashboardSchema,MetricCardSchema}from'@object-ui/plugin-dashboard';constmetricCard: MetricCardSchema={type: 'metric-card',title: 'Revenue',};

两个类型名在 packages/plugin-dashboard/src 的导出面上都没有,在 @object-ui/types 里也没有。DashboardSchema 之所以看起来"像有",是因为它只出现在注释里(src/DashboardRenderer.tsx:884src/DashboardGridLayout.tsx:76/:88)—— 按标识符 grep 会命中,按导出面查就没有。metric card 那一侧真实存在的类型是 MetricCardProps(src/MetricCard.tsx:35),而它也没有从 src/index.tsx re-export(index 只导出组件 MetricCardWidgetConfigPanelProps)。

所以这一节照抄是 TS2305,且改不成"同名换路径"—— 需要先决定 dashboard 的 schema 类型对外叫什么、从哪导出。

与本族其他单的差别

这一族其余各单(*Components 手动注册)是照抄即运行时抛;本单是纯类型面,只在 TS 消费者那里红。定级交 PM。

同族

#5002 是同族的源头单(plugin-map)。实施 #5002 时把 19 个 packages/plugin-*/README.md 的自包命名导入与各包真实导出面对了一遍,命中 8 个包:calendar(#5010)、form(#5011)、gantt(#5012)、grid(#5013)、view(#5014)、dashboard(本单)、report。按 #5002 认领评论的裁定「兄弟 README 只查不改」,各包各立一单。

顺带记一笔:plugin-dashboarddashboardComponents真实存在的(src/index.tsx:338),所以这一族不能按名字模式批量断言,必须逐包对导出面。

复核方式

grep -n "DashboardSchema\|MetricCardSchema" packages/plugin-dashboard/README.md
grep -rn "\bDashboardSchema\b\|\bMetricCardSchema\b" packages/plugin-dashboard/src # 仅注释命中
grep -rn "MetricCardProps" packages/plugin-dashboard/src/index.tsx # 零命中(未 re-export)

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationpm:queue

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions