From 892393ec5826effcf0a8991a1bc16e8a3366e40a Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 7 Aug 2026 16:53:59 +0000 Subject: [PATCH] =?UTF-8?q?docs(runner):=20=E6=8A=8A=20README=20=E4=B8=A4?= =?UTF-8?q?=E5=A4=84=E5=BC=80=E6=94=BE=E9=9B=86=E5=90=88=E7=9A=84=E6=8F=92?= =?UTF-8?q?=E4=BB=B6=E6=8E=AA=E8=BE=9E=E6=8C=89=E5=AE=9E=E6=B5=8B=E9=97=AD?= =?UTF-8?q?=E5=90=88=20(#3632)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `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 Claude-Session: https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt --- packages/runner/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/packages/runner/README.md b/packages/runner/README.md index 0fa8f48c4f..6b46d1f4b6 100644 --- a/packages/runner/README.md +++ b/packages/runner/README.md @@ -8,7 +8,7 @@ Universal Object UI Application Runner - A standalone development server and run - **No-Restart Edits** - Under `src/app-data/` the dev server picks metadata changes up without a restart, because that JSON is part of Vite's module graph; behind `?api=` it cannot, because Vite never sees your backend ([Metadata Loading](#metadata-loading)) -- **Plugin Support** - Pre-configured with popular plugins (Kanban, Charts, etc.) +- **Plugin Support** - Pre-configured with the Kanban and Charts plugins - **Development Ready** - Built-in Vite development server - **Production Build** - Optimized build for deployment @@ -42,11 +42,16 @@ pnpm preview ## Pre-installed Plugins -The runner comes with these plugins pre-configured: +The runner comes with these two plugins pre-configured, registered by the imports in +`src/App.tsx`: - **@object-ui/plugin-kanban** - Kanban board components - **@object-ui/plugin-charts** - Chart visualization components -- **Additional plugins can be added as needed** + +Adding any other plugin means editing the runner's own sources and rebuilding — a +dependency in `package.json`, a registration import in `src/App.tsx`, and the +`vite.config.ts` alias and `src/index.css` `@source` entries the two above have. There +is no runtime plugin installation. ## Metadata Loading