跳至内容

安装插件

以下命令与管理行为对应 0.2.1-rc.5。安装前先确定正在使用的 DSH 版本、目标 Profile,以及插件的具体版本或 Git ref;插件目录中的收录不代表该组合已经兼容。

选择安装方式

你要做什么使用方式安装前确认
安装已发布的包npm 包名加具体版本包的兼容范围和 dsh.bundle.patch 声明
使用仓库中的特定实现github:owner/repo#ref固定 tag 或 commit,以及该 ref 是否包含可安装的包
开发本地插件本地路径、file: 或 link:包的构建产物、依赖和链接路径;代码改动后仍需构建并重新加载

dsh plugin 将包管理参数转发给 pnpm。CLI 安装前确保 pnpm 在 PATH 中。以下是命令形式,替换包名、版本或 ref 后再使用:

dsh plugin --profile web add "package-name@version"
dsh plugin --profile web add "github:owner/repo#ref"

--profile web 必须放在 add 等 pnpm 参数之前。它选择要修改的 Profile,不会把插件同时安装到所有 Profile。命令自身的帮助是 dsh plugin --help;pnpm 的 add 帮助是 dsh plugin --profile web add --help。

区分安装、选中与可用

以给 Web Profile 增加一个界面 Bundle 为例,依次检查三件事:

  1. 依赖已安装:pnpm 操作成功,目标 Profile 保存了依赖。普通依赖可以安装,但没有 dsh.bundle.patch 就不会成为活动配置层。
  2. Bundle 已选中:管理器把 Bundle 写入 Profile 的有序 dsh.profile.bundles。新 Bundle 安装时默认选中;enabled 只表示保存的选择,不能证明加载成功。已选中但不可加载的 Bundle 仍会列出,并带有错误。
  3. 功能已生效:检查对应界面或功能是否出现,并查看加载错误。启用 HMR 时配置变化可立即应用;未启用 HMR 或结果要求 restart-required 时,停止并重新运行相同的 dsh --profile web,再检查一次。

在 rc.5 的 Web 界面中,侧栏 Plugins 页面管理 Bundle 和可操作的插件条目;设置中的 Plugin 列表只读。禁用 Bundle 会保留依赖,再次启用会把它放在 Bundle 列表末尾,可能改变配置覆盖顺序。同一 Profile 的改动会影响使用它的所有会话。

失败时检查哪一层

现象检查与处理
提示找不到 pnpm,或包下载失败先解决 PATH、包规格或包管理器报告的网络与安装错误;不要把它归为插件加载失败
报 incompatible-version读取包名、包版本、运行时版本及 requirements;有 engines.dsh 时以它为兼容规则,否则检查 DSH peer 依赖,选择匹配版本
安装完成但没有 Bundle 或界面检查 dsh.bundle.patch、目标 Profile 与保存的选中状态;普通依赖不会自动变成插件层
Bundle 显示已启用但有加载错误读取 Bundle 的错误;应用阶段失败可能已保留依赖和选中状态,不能仅凭 pnpm 成功重试安装。修复包或先取消选中,再按需移除依赖
功能仍是旧状态查看是否要求重启,并确认重启的是安装时修改的 Profile

旧的 &path: 子路径和 Repository Plugin 写法不属于此处的 Bundle 安装流程。使用声明了 dsh.bundle.patch 的可安装包。

第三方代码的执行边界

插件由各自作者维护。安装前审阅源码、manifest 和安装脚本;安装后的 Host 插件在进程内执行,不受工作区沙箱限制。插件管理操作的批准也不等于依赖构建脚本已获批准。具体检查见插件安全使用。

来源与下一步