docs(runner): 把 README 两处开放集合的插件措辞按实测闭合 (#3632) - #3644
Merged
Conversation
`packages/runner/README.md` 两处把预装插件写成开放集合,实测预装的恰好是 kanban + charts 两个:`packages/runner/package.json` 的 dependencies 里 `plugin-*` 只有 `@object-ui/plugin-charts` 与 `@object-ui/plugin-kanban`, `packages/runner/src/App.tsx:14-15` 也只有这两行注册 import。 - §Features:`(Kanban, Charts, etc.)` 已穷举全部两个却仍缀 `etc.`,读起来是 「还有更多没列」。去掉 `etc.` 并闭合为实测集合;一并去掉 `popular` —— 集合闭合后「popular plugins」仍读作「从更大集合里挑的几个热门」,会把刚 合上的口子重新撑开。 - §Pre-installed Plugins:非插件的加粗行「**Additional plugins can be added as needed**」被排在「comes with these plugins pre-configured」引出的列表 里、且与前两条同样加粗,形状上成了第三个预装项。把它移出列表,降为列表 下方的说明句,并按实测写清加插件的真实代价(改 `package.json` 依赖、 `src/App.tsx` 注册 import,以及现有两个插件在 `vite.config.ts` 别名表和 `src/index.css` `@source` 里各有的条目)后重新构建 —— runner 没有运行时 插件安装机制。 无 changeset:包 README 的事实订正,不改任何发布产物或公开 API,沿用 #3602 / #3621 / #3634 的先例。 Fixes #3632 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt
Contributor
✅ Console Performance Budget
📦 Bundle Size Report
Size Limits
|
yinlianghui
marked this pull request as ready for review
August 7, 2026 16:57
This was referenced Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3632
前提复核(独立于 issue 正文)
切点
fa3ba5bf1。issue 正文的行号已漂(#3621 / #3634 改过同文件),按内容锚定复核,两处缺陷都仍在,实测预装集合与 issue 正文一致 —— 恰好两个,无差异:packages/runner/package.jsondependencies 的plugin-*@object-ui/plugin-charts、@object-ui/plugin-kanbanpackages/runner/src/App.tsx:14-15注册 import@object-ui/plugin-kanban、@object-ui/plugin-chartspackages/runner/src全量plugin-grepindex.css:13-14的@source、vite.config.ts:77-78的别名 —— 同样只覆盖这两个行号漂移:§Features 该行 9 → 11,§Pre-installed Plugins 41-47 → 43-49。
前后对照
§Features
括号里已经穷举了全部两个,末尾却缀
etc.,读起来是「还有更多没列」。一并去掉popular:集合闭合之后,「popular plugins (Kanban, Charts)」仍读作「从更大集合里挑的几个热门的」,会把刚合上的口子重新撑开 —— 这个词与闭合措辞不相容,不是顺手润色。§Pre-installed Plugins
第三条不是插件,却被排在一句「comes with these plugins pre-configured」引出的列表里、且和前两条一样加粗,形状上与两个真插件并列,扫读时会被当成第三个预装项。按 issue 建议降为列表下方的一句正文。
保留(而非删除)的措辞理由:该节读者的下一个问题必然是「那我怎么加别的插件」,留空反而会让人去猜一个不存在的运行时机制。这句话按实测写清真实代价,四个落点都已复核 ——
package.jsondependencies、App.tsx:14-15、vite.config.ts:77-78、index.css:13-14,现有两个插件在后两处各有条目。末句「There is no runtime plugin installation」把 issue 关心的那个误读直接堵死。措辞上刻意说「the entries the two above have」(现有两个插件各有的条目)而不是「required」:vite 别名表的作用是让 runner 直接从 monorepo 源码启动(见
vite.config.ts:42-43关于 #3575 的注释),把它写成硬性必需会是新的过度断言 —— 陈述现状而不越界断言。验证(先预测后跑)
三条预测,全部命中:
etc.零命中,§Pre-installed Plugins 列表恰两项docs:check-links修前修后皆绿关于扫描面(#3622 在途扩包 README 扫描面):本切点上
packages/**还不在扫描面内 ——scripts/check-doc-links.mjs:355-362的SCAN_ROOTS是content/docs/examples/README.md/CONTRIBUTING.md/ROADMAP.md/docs六项,脚本自己在第 264 行写着「Measured and NOT bought: the package READMEs (objectui#3622)」。也就是说这道门禁目前根本没读到本文件,它的绿不构成对本改动的证明。真正的证据是链接零增删:git show HEAD:packages/runner/README.md与工作区各 12 个 markdown 链接,两处改动都不含链接。#3622 落地后本文件进扫描面也不受影响。check:control-bytes绿 + 自扫干净未跑
pnpm test/type-check:本 PR 是纯 README 文本改动,零代码行,runner 的 vitest 与 tsc 都不读 README —— 跑一遍只会在共用容器里烧内存换一个与本改动无关的绿。如实记录,不补造证据。无 changeset
包 README 的事实订正,不改任何发布产物或公开 API,沿用 #3602 / #3621 / #3634 的先例。
越界发现(只报不改)
通读两节邻接,§Features 其余四条与 §Running the Runner、§Metadata Loading 均已复核属实(
dev: vite/build: vite build脚本存在;package.json确实没有main/module/exports/types)。同类新虚构:无。另有一处非同类、非邻接的发现(生成块的版本漂移,波及 35 个包 README),已按仓规单独建 issue 归档,不在本 PR 修改。
⛔ 未碰
content/docs/utilities/runner.mdx(#3618 在途)。🤖 Generated with Claude Code
https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt
Generated by Claude Code