返回目录
其他 待识别

dsh-plugin-pub-review

weopenfire-git/dsh-plugin-pub-review

Publish-readiness review for DeepSeek Harness plugins: official docs freshness check (docs-check), 30+ static checks with a Ready/Not-Ready verdict (plugin-review), and publish preflight + command guidance (plugin-publish).

Stars
0
Forks
0
Issues
0
更新
1 天前

PROJECT TOPICS

项目标签

PROJECT README

README

dsh-plugin-pub-review — 发布就绪审查:给 dsh 插件做体检

English | 中文

发布前一站式审查(publish-readiness review):查官方文档有没有更新 → 按官方规范做 30+ 项静态体检 → 只读预检 + 发布命令引导。让「能不能发布」有依据,而不是靠感觉。

体检流程(医院比喻)

[1. 规则查验] ──> [2. 静态体检] ──> [3. 诊断报告] ──> [4. 预检与发布]
 (docs-check)     (plugin-review)    (✅/❌/⚠️ 药方)   (plugin-publish)

定位

发布就绪审查回答两件事:这个插件能不能发怎么发

  1. 先核官方文档:docs-check 检查官方插件开发文档有没有更新——避免用过期的规范「错诊」;
  2. 再按规范体检:plugin-review 对照官方 basic 文档与骨架经验规则做 30+ 项静态检查,输出 ✅/⚠️/❌ 清单、修复药方与 Ready / Not-Ready 判定;
  3. 最后引导发布:plugin-publish 只读预检(typecheck/test/build/npm pack),生成 git commit/tag/push 命令序列——npm publish 始终留给你手动执行(2FA 屏障)。

🚀 现状

版本 亮点
v0.2.1+ README 重构与校准:主文不点名其他插件;对比表移至文末并校准部分符合标注
v0.2.0 更名 dsh-plugin-pub-review(原 dsh-plugin-doctor),突出「发布就绪审查」定位
v0.1.x 三个工具 + 斜杠命令 + 启动横幅 + 测试

工具

1. docs-check —— 审查前的「医学规范核查」

避免用过期规则「错诊」:审查前自动核对官方插件开发文档是否更新。

  • 多源回退:优先 GitHub contents API(按文件 sha 快速比对,网络实测可达 200);失败时自动回退本地 DSHarness checkout
  • 状态持久化~/.dsh/plugin-pub-review/docs-state.json 记录每篇上次 sha 与检查时间;官方规则更新时提醒「规则库需要复核」

2. plugin-review —— 静态「全身体检」与诊断

对目标插件仓库做 30+ 项静态检查,输出 ✅/⚠️/❌ 清单 + 修复药方 + 发布就绪判定(Ready / Not Ready)。

检查文件 诊断关注点
package.json type: "module"、main/types/exports 指向 lib、files 只发 lib、scripts(build/typecheck/test/prepare)、peerDependencies 用范围(cordis + dsh-*)、schemastery 在 dependencies
tsconfig.json strict、declaration、outDir lib/types、rootDir src、moduleResolution bundler、TS 扩展重写
tsdown.config.ts entry 指向 lib/types/index.js、clean: false
vitest.config.ts root 指向仓库根、include tests/*/.spec.ts
src/index.ts name / inject / apply 三件套
仓库基础 .gitignore(node_modules/ lib/ .dsh/)、tests/ 用例存在、README 双语 + Changelog、version.ts 同步

3. plugin-publish —— 预检与「出院」发布引导

  • 只读安全预检:自动依次执行 typecheck → test → build → npm pack --dry-run
  • 发布指令安全下发:生成 git commit/tag/push 命令序列(autoRunGit=true 时自动执行)
  • 2FA 人工安全屏障:涉及账号安全的 npm publish 始终保留给你手动确认

架构要点

  • 纯函数式检测:配置文件解析 + 正则匹配,毫秒级完成全部检查,不依赖笨重的 AST 库
  • 软集成(零硬依赖):斜杠命令通过 ctx.get('commands') 注册;宿主未挂载 commands 服务时静默跳过,仅保留工具能力,绝不侵入宿主
  • 确定性状态机:✅ Pass / ⚠️ Warning / ❌ Error(发布阻断)三态,每条带可复制的修复药方

诚实边界

  1. 规则是手写的;docs-check 只检测「文档变了没有」,不自动提取新规则——变了由 agent 复核该核对的点。
  2. npm publish 需要用户 2FA,插件只预检 + 引导。
  3. 静态检查能抓结构/构建/发布问题;更深的设计/逻辑问题由 agent 根据报告处理。

安装与使用

开发期:profile 的 cordis.patch.yml 加 host 行:

- insert:
    - id: dsh-plugin-pub-review
      name: file:///D:/work/ClaudeCode/dsh-plugin-pub-review/src/index.ts

正式使用dsh plugin --profile <name> add @yinging/dsh-plugin-pub-review

使用:加载后终端打印启动横幅;斜杠命令:

  • /plugin-review —— 先查官方文档更新,再对当前工作区仓库静态体检,输出报告与发布就绪判定
  • /plugin-publish —— 运行预检流水线,给出发布命令序列
  • /doctor-help —— 显示本使用引导

配置(config.ts)

字段 默认 含义
docsUrls basic 四篇 contents API 要查更新的官方文档
docsStateFile ~/.dsh/plugin-pub-review/docs-state.json 上次哈希状态
checkDocsBeforeReview true review 前先查文档
autoRunGit false publish 是否自动跑 git 步骤

同类工具对比

dsh 生态中做「插件健康/审查/验证」的工具不止一个,下表按覆盖环节对比(以各仓库官方描述为准:「—」表示描述未覆盖此环节,⚠️ 表示部分符合,如仅有判定而无完整能力):

工具 文档新鲜度 静态规范检查 构建/打包 安装验证 环境诊断 发布引导 官方定位(摘要)
dsh-plugin-pub-review(本插件) ✅(30+ 项) ✅(只读预检) ✅(git 序列 + npm 引导) 发布就绪审查:官方文档符合性 + 静态体检 + 发布引导
dsh-plugin-check 插件健康检查(manifest/patch 格式、构建陷阱、hub 收录)
zoahdev/dsh-plugin-doctor ✅(fresh-profile 安装) ⚠️(preflight/check 判定,无 git 序列) 运行级验证:装包、安装、供应链预检、环境诊断
dsh-test-drive ✅(装-冒烟-卸) 隔离 DSH_HOME 里的插件装-冒烟-卸实测
dsh-inspect ✅(对抗式) checkup → fix → review 对抗式闭环
dsh-review-loop 增量 diff 审查循环(面向代码,非插件体检)
dsh-doublecheck ✅(门禁) 工程纪律闭环:需求盘问、红绿测试门禁、对抗交付评审
dsh-ops-skill 运行时可靠性:状态快照、升级差异、回归检查
dsh-verification-receipt 每轮工具计数与验证信号写入本地 JSONL
dsh-doctor 一键本地环境健康检查(版本/端口/配置/会话日志)

结论:本插件独有的是「文档新鲜度检查」与「git commit/tag/push 命令序列生成」两项——前者其余工具全覆盖不到;后者 zoahdev 仅有 preflight/check 判定(评估是否就绪、供选择发布路径),但不生成可直接执行的发布命令序列(见对比表中的 ⚠️)。静态规范检查与部分工具重叠,但侧重不同(对照官方 basic 文档 + 骨架经验规则的手写清单)。安装级验证与环境诊断分别由对应工具承担,本插件刻意不做(见诚实边界);需要完整发布体检时,可先跑本插件过规范,再配合安装/环境验证工具补全运行侧。

Changelog

  • v0.2.3 — 对比表校准:zoahdev 的「发布引导」改为 ⚠️ 部分符合(有 preflight/check 判定、无 git 命令序列);结论同步为「文档新鲜度 + git 序列生成」两项独有。
  • v0.2.2 — README 清理:移除文末模板出处引用。
  • v0.2.0 — 更名 dsh-plugin-pub-review(原 dsh-plugin-doctor,npm 旧包已弃用),明确「发布就绪审查」定位:官方文档符合性 + 静态规范体检 + 发布引导;文档状态路径改为 ~/.dsh/plugin-pub-review/
  • v0.1.1 — 启动横幅与 /doctor-help 引导命令;README 补全流程/检查点/架构/配置说明。
  • v0.1.0 — 首个发布:三个工具完整实现(docs-check 多源哈希对比、plugin-review 静态体检、plugin-publish 预检 + 命令生成)、两个斜杠命令、vitest 用例。

CLASSIFICATION EVIDENCE

分类依据

项目类型待识别
功能分类其他
规则置信度

系统优先读取 GitHub Topics,再与站内分类词典和词根规则比对。当前命中: 无有效分类标签。