rebrand-plugin 使用指南
dsh-harmony 的官方示例插件:把 DSH WebUI 侧边栏的品牌标识替换为自定义 "Custom DSH" 文字,演示 element() 工厂改写 React 组件。
本文为派生内容(基于 wiki / faq / compatibility_json 自动组装),非 AI 即时创作。
本文由本站基于该插件已收录的字段自动派生(wiki / faq / compatibility_json / readme),非 AI 即时创作。每节末尾标源字段。
快速上手
dsh-harmony (rebrand-plugin)
— 源: plugin_wiki.wiki_content
安装与验证
dsh plugin --profile web add github:CH4ACKO3/dsh-harmony#path:packages/react/examples/rebrand-plugin
复制以上命令在 DSH Web Profile 内运行。安装完成后在「插件列表」启用即可。
— 源: plugins.install
常见问题
这个插件实际能做什么?
它在 DSH WebUI 启动时把内置侧边栏的 BrandWordmark 组件整体替换为一个简单的 React 组件,渲染为 Custom DSH 文字,用于演示 dsh-harmony-react 的 element() 工厂如何改写编译后的 React 组件(src/patch.cts:3-20、src/client.ts:7-9)。
我装上之后侧边栏会变成什么样?
侧边栏原本的品牌字标会被一行加粗的 "Custom DSH" 文字取代;除此之外界面其它部分不变。补丁的目标包被钉在 @deepseek-ai/[email protected](src/patch.cts:6-9)。
这是给普通用户日常使用的插件吗?
不是。它是 dsh-harmony 仓库里的官方示例,主要给插件作者用来学习 element() 工厂、Patch 注册和 harmony.patch.yml 的写法。普通用户通常不会直接安装它,而是参考它改写成自己的换肤/换标识插件。
安装后需要重启 DSH 吗?
需要。Harmony 改写发生在 DSH 启动前的模块加载阶段,安装或更新后必须重启 DSH,新组件才会生效;插件本身的 apply 为空操作,仅注册 Patch(src/index.cts:1-2)。
能用这个示例改成自己的换标插件吗?
可以。复制 src/patch.cts 替换自己的 React 组件名、再在 src/client.ts 用 window.ModuleLoader.load 注册你的组件导出,最后在 harmony.patch.yml 里把 id 改掉即可;目标包仍需锁定到 0.1.0-rc.8(src/patch.cts:3-20、src/client.ts:1-14、harmony.patch.yml:1-4)。
卸载它能恢复原来的侧边栏品牌吗?
能。Patch 只在内存里改写代码,不会修改 node_modules,移除插件后下次启动 DSH 即恢复原状(README.md:54-58、README.md:91-94)。
升级 dsh-client-ui-sidebar 之后这个示例会失效吗?
会。Patch 用 target.version 锁定了 0.1.0-rc.8,当宿主升级到该范围之外的版本时,Patch 会进入 failed 状态并不再改写,但不会阻塞 DSH 启动(src/patch.cts:6-9、README.md:115-118)。
— 源: plugin_wiki.faq_json
兼容性
- DSH: 0.1.0-rc.8+
- Node: ^22.22.3 || >=24.11.1
- Platforms: Web
— 源: plugin_wiki.compatibility_json
踩坑提醒
安装前请审阅上游仓库;本指南基于已收录字段自动派生,可能滞后于最新版本。如发现与官方文档冲突,请以上游为准。
— 来源:通用规则