dsh-plugin-showcase 0.1.0 → 0.2.0

package/lib/index.js

@@ -4,13 +4,20 @@ import { join } from 'node:path'
 export const name = 'showcase'
 export const inject = ['tools', 'commands']
 
-const VERSION = '0.1.0'
+const VERSION = '0.2.0'
 const TOOL_NAME = 'showcase_inspect'
+const DOCTOR_TOOL_NAME = 'showcase_doctor'
 const COMMAND_NAME = 'showcase'
 const DENY_REASON = 'showcase: 拒绝执行破坏性命令'
-const USAGE = '/showcase [on|off]'
+const USAGE = '/showcase [on|off|doctor|about]'
 const UNKNOWN = '未知'
 
+const LOCALE_NAMESPACE = 'locale'
+const LOCALE_FIELD = 'preference'
+const APP_BOOT_PACKAGE = '@deepseek-ai/dsh-app-boot'
+const STATUS_LABELS = Object.freeze({ ok: 'OK', warn: 'WARN', fail: 'FAIL', unknown: '?' })
+const HINT_FAULT = '这是 showcase 自身的缺陷：重跑 /showcase doctor，仍失败请到插件页反馈'
+
 const DESTRUCTIVE_PATTERNS = Object.freeze([
   'rm -rf /',
   'rm -rf ~',
@@ -198,7 +205,7 @@ async function buildSnapshot(ctx, state, agent) {
     generatedAt: new Date().toISOString(),
     workspace: { cwd, gitBranch },
     session: { id: sessionId, model: sessionModel },
-    plugin: { version: VERSION, gateEnabled: gate, toolName: TOOL_NAME, command: '/' + COMMAND_NAME },
+    plugin: { version: (await readOwnManifest()).version, gateEnabled: gate, toolName: TOOL_NAME, command: '/' + COMMAND_NAME },
     sections: [
       {
         title: '工作区',
@@ -217,7 +224,7 @@ async function buildSnapshot(ctx, state, agent) {
       {
         title: '插件',
         items: [
-          { label: '版本', value: VERSION },
+          { label: '版本', value: (await readOwnManifest()).version },
           { label: '拦截门', value: gate ? '开启' : '关闭' },
           { label: '工具', value: TOOL_NAME },
           { label: '命令', value: '/' + COMMAND_NAME },
@@ -227,6 +234,307 @@ async function buildSnapshot(ctx, state, agent) {
   }
 }
 
+function messageOf(error) {
+  return error instanceof Error ? error.message : String(error)
+}
+
+let ownManifestPromise = null
+
+async function loadOwnManifest() {
+  try {
+    const text = await readFile(new URL('../package.json', import.meta.url), 'utf8')
+    const parsed = JSON.parse(text)
+    const engines = parsed !== null && typeof parsed === 'object' && parsed.engines !== null && typeof parsed.engines === 'object'
+      ? parsed.engines
+      : {}
+    return {
+      version: typeof parsed.version === 'string' && parsed.version !== '' ? parsed.version : VERSION,
+      dshRange: typeof engines.dsh === 'string' && engines.dsh !== '' ? engines.dsh : null,
+    }
+  } catch {
+    return { version: VERSION, dshRange: null }
+  }
+}
+
+function readOwnManifest() {
+  if (ownManifestPromise === null) ownManifestPromise = loadOwnManifest()
+  return ownManifestPromise
+}
+
+const SEMVER = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+[0-9A-Za-z.-]+)?$/u
+const COMPARATOR = /^(>=|<=|>|<|=|\^|~)?(\S+)$/u
+
+function parseSemver(text) {
+  const match = typeof text === 'string' ? SEMVER.exec(text.trim()) : null
+  if (match === null) return null
+  return {
+    major: Number(match[1]),
+    minor: Number(match[2]),
+    patch: Number(match[3]),
+    pre: match[4] === undefined ? [] : match[4].split('.'),
+  }
+}
+
+function compareIdentifier(left, right) {
+  const leftNumeric = /^\d+$/u.test(left)
+  const rightNumeric = /^\d+$/u.test(right)
+  if (leftNumeric && rightNumeric) return Number(left) - Number(right)
+  if (leftNumeric) return -1
+  if (rightNumeric) return 1
+  return left === right ? 0 : left < right ? -1 : 1
+}
+
+function compareSemver(left, right) {
+  for (const key of ['major', 'minor', 'patch']) {
+    if (left[key] !== right[key]) return left[key] - right[key]
+  }
+  if (left.pre.length === 0 && right.pre.length === 0) return 0
+  if (left.pre.length === 0) return 1
+  if (right.pre.length === 0) return -1
+  const length = Math.max(left.pre.length, right.pre.length)
+  for (let index = 0; index < length; index += 1) {
+    const leftPart = left.pre[index]
+    const rightPart = right.pre[index]
+    if (leftPart === undefined) return -1
+    if (rightPart === undefined) return 1
+    const delta = compareIdentifier(leftPart, rightPart)
+    if (delta !== 0) return delta
+  }
+  return 0
+}
+
+function upperBound(operator, target) {
+  if (operator === '^') {
+    if (target.major > 0) return { major: target.major + 1, minor: 0, patch: 0, pre: [] }
+    if (target.minor > 0) return { major: 0, minor: target.minor + 1, patch: 0, pre: [] }
+    return { major: 0, minor: 0, patch: target.patch + 1, pre: [] }
+  }
+  return { major: target.major, minor: target.minor + 1, patch: 0, pre: [] }
+}
+
+/** true/false when the range is a plain comparator set; null when it is not one this host can parse offline. */
+function satisfiesRange(version, range) {
+  const text = typeof range === 'string' ? range.trim() : ''
+  if (text === '' || text === '*' || text === 'x') return true
+  if (text.includes('||')) return null
+  for (const token of text.split(/\s+/u).filter(part => part !== '')) {
+    const match = COMPARATOR.exec(token)
+    if (match === null) return null
+    const operator = match[1] === undefined ? '=' : match[1]
+    const target = parseSemver(match[2])
+    if (target === null) return null
+    const delta = compareSemver(version, target)
+    if (operator === '>=' && delta < 0) return false
+    if (operator === '>' && delta <= 0) return false
+    if (operator === '<=' && delta > 0) return false
+    if (operator === '<' && delta >= 0) return false
+    if (operator === '=' && delta !== 0) return false
+    if (operator === '^' || operator === '~') {
+      if (delta < 0) return false
+      if (compareSemver(version, upperBound(operator, target)) >= 0) return false
+    }
+  }
+  return true
+}
+
+async function readDshVersion(ctx) {
+  const profile = readService(ctx, 'profileContext')
+  const dir = profile !== null && typeof profile.dir === 'string' && profile.dir !== '' ? profile.dir : null
+  if (dir === null) return null
+  try {
+    const parts = APP_BOOT_PACKAGE.split('/')
+    const text = await readFile(join(dir, 'node_modules', ...parts, 'package.json'), 'utf8')
+    const parsed = JSON.parse(text)
+    const version = parsed !== null && typeof parsed === 'object' ? parsed.version : undefined
+    return typeof version === 'string' && version !== '' ? version : null
+  } catch {
+    return null
+  }
+}
+
+function readLocale(ctx) {
+  const settings = readService(ctx, 'settings')
+  if (settings === null || typeof settings.describe !== 'function') return null
+  const descriptors = settings.describe()
+  if (!Array.isArray(descriptors)) return null
+  for (const descriptor of descriptors) {
+    if (descriptor === null || typeof descriptor !== 'object') continue
+    if (String(descriptor.ns) !== LOCALE_NAMESPACE) continue
+    const value = descriptor.value !== null && typeof descriptor.value === 'object' ? descriptor.value : {}
+    const preference = typeof value[LOCALE_FIELD] === 'string' ? value[LOCALE_FIELD] : ''
+    return preference === '' ? null : preference
+  }
+  return null
+}
+
+function readMarketIndexes(ctx) {
+  const market = readService(ctx, 'pluginMarket')
+  if (market === null || typeof market.listIndexes !== 'function') return { available: false, entries: [] }
+  const entries = market.listIndexes()
+  if (!Array.isArray(entries)) return { available: true, entries: [] }
+  return { available: true, entries: entries.filter(entry => entry !== null && typeof entry === 'object') }
+}
+
+function checkEngine(manifest, dshVersion) {
+  if (dshVersion === null) {
+    return {
+      status: 'unknown',
+      detail: '读不到 DSH 运行时版本',
+      hint: '需要 profileContext 服务，且 <profile>/node_modules/' + APP_BOOT_PACKAGE + '/package.json 可读',
+    }
+  }
+  const range = manifest.dshRange
+  if (range === null) {
+    return { status: 'warn', detail: '运行 ' + dshVersion + '，package.json 未声明 engines.dsh', hint: '补上 engines.dsh 后本项可比对兼容性' }
+  }
+  const parsed = parseSemver(dshVersion)
+  const satisfied = parsed === null ? null : satisfiesRange(parsed, range)
+  if (satisfied === null) {
+    return { status: 'unknown', detail: '运行 ' + dshVersion + '，要求 ' + range + '（范围写法无法离线解析）', hint: '该范围不是简单比较式，请人工确认兼容性' }
+  }
+  if (satisfied) return { status: 'ok', detail: '运行 ' + dshVersion + '，要求 ' + range, hint: null }
+  return { status: 'fail', detail: '运行 ' + dshVersion + '，要求 ' + range, hint: '升级 DSH，或改用与本机版本兼容的插件版本' }
+}
+
+function checkCwd(cwd) {
+  if (cwd === '') return { status: 'warn', detail: '读不到工作目录', hint: '需要 workingDirectory 服务，或本会话尚未选定目录' }
+  return { status: 'ok', detail: cwd, hint: null }
+}
+
+function checkModel(model) {
+  if (model === null) return { status: 'unknown', detail: '读不到默认模型', hint: '需要 agentDefaultModel 服务，或在设置里选定一次默认模型' }
+  return { status: 'ok', detail: model, hint: null }
+}
+
+function checkGate(gateEnabled) {
+  if (gateEnabled) return { status: 'ok', detail: '拦截门已开启', hint: null }
+  return { status: 'warn', detail: '拦截门已关闭', hint: '用 /showcase on 重新开启' }
+}
+
+function checkLocale(locale) {
+  if (locale === null) return { status: 'unknown', detail: '读不到宿主语言偏好', hint: '在设置里显式选择界面语言后，本项会显示 locale 偏好' }
+  return { status: 'ok', detail: locale, hint: null }
+}
+
+function checkMarket(market) {
+  if (!market.available) return { status: 'unknown', detail: '读不到市场索引服务 pluginMarket', hint: '该部署未挂载插件市场时本项可以忽略' }
+  if (market.entries.length === 0) return { status: 'warn', detail: '未配置市场索引源', hint: '在设置 → 插件市场里添加索引 URL' }
+  const describe = entry => (typeof entry.url === 'string' && entry.url !== '' ? entry.url : UNKNOWN)
+  const broken = market.entries.filter(entry => typeof entry.error === 'string' && entry.error !== '')
+  if (broken.length > 0) {
+    return {
+      status: 'warn',
+      detail: market.entries.length + ' 个索引源，' + broken.length + ' 个不可用: ' + broken.map(describe).join(', '),
+      hint: '修正或删除不可用的索引 URL',
+    }
+  }
+  return { status: 'ok', detail: market.entries.length + ' 个索引源: ' + market.entries.map(describe).join(', '), hint: null }
+}
+
+async function runCheck(id, title, produce) {
+  try {
+    const result = await produce()
+    if (result === null || typeof result !== 'object') {
+      return { id, title, status: 'unknown', detail: '检查未返回结果', hint: HINT_FAULT }
+    }
+    const status = STATUS_LABELS[result.status] === undefined ? 'unknown' : result.status
+    return {
+      id,
+      title,
+      status,
+      detail: typeof result.detail === 'string' ? result.detail : '',
+      hint: typeof result.hint === 'string' && result.hint !== '' ? result.hint : null,
+    }
+  } catch (error) {
+    return { id, title, status: 'unknown', detail: '检查异常: ' + messageOf(error), hint: HINT_FAULT }
+  }
+}
+
+function buildHealthSchema() {
+  return {
+    type: 'object',
+    additionalProperties: false,
+    required: ['generatedAt', 'pluginVersion', 'dshVersion', 'summary', 'checks'],
+    properties: {
+      generatedAt: { type: 'string', description: 'ISO 8601 timestamp of this report.' },
+      pluginVersion: { type: 'string' },
+      dshVersion: { ...nullableString(), description: 'Running DSH version, null when unreadable.' },
+      summary: {
+        type: 'object',
+        additionalProperties: false,
+        required: ['ok', 'warn', 'fail', 'unknown'],
+        properties: {
+          ok: { type: 'integer' },
+          warn: { type: 'integer' },
+          fail: { type: 'integer' },
+          unknown: { type: 'integer' },
+        },
+      },
+      checks: {
+        type: 'array',
+        items: {
+          type: 'object',
+          additionalProperties: false,
+          required: ['id', 'title', 'status', 'detail', 'hint'],
+          properties: {
+            id: { type: 'string' },
+            title: { type: 'string' },
+            status: { type: 'string', enum: ['ok', 'warn', 'fail', 'unknown'] },
+            detail: { type: 'string' },
+            hint: { ...nullableString(), description: 'Next step, null when there is none.' },
+          },
+        },
+      },
+    },
+  }
+}
+
+function renderHealth(value) {
+  const report = value !== null && typeof value === 'object' ? value : {}
+  const generatedAt = typeof report.generatedAt === 'string' ? report.generatedAt : ''
+  const lines = ['DSH 体检报告 ' + generatedAt]
+  const checks = Array.isArray(report.checks) ? report.checks : []
+  for (const check of checks) {
+    if (check === null || typeof check !== 'object') continue
+    const label = STATUS_LABELS[check.status] === undefined ? STATUS_LABELS.unknown : STATUS_LABELS[check.status]
+    const title = typeof check.title === 'string' ? check.title : UNKNOWN
+    const detail = typeof check.detail === 'string' ? check.detail : ''
+    lines.push('[' + label + '] ' + title + ' — ' + detail)
+    if (typeof check.hint === 'string' && check.hint !== '') lines.push('  ↳ ' + check.hint)
+  }
+  const summary = report.summary !== null && typeof report.summary === 'object' ? report.summary : {}
+  const count = key => (typeof summary[key] === 'number' ? summary[key] : 0)
+  lines.push('合计: ok ' + count('ok') + ' / warn ' + count('warn') + ' / fail ' + count('fail') + ' / unknown ' + count('unknown'))
+  return lines.join('\n')
+}
+
+async function buildHealthReport(ctx, state, agent) {
+  const manifest = await readOwnManifest()
+  const [dshVersion, cwd] = await Promise.all([readDshVersion(ctx), readCwd(ctx, agent)])
+  const model = readModel(ctx)
+  const checks = await Promise.all([
+    runCheck('engine.dsh', 'DSH 版本', () => checkEngine(manifest, dshVersion)),
+    runCheck('workspace.cwd', '工作目录', () => checkCwd(cwd)),
+    runCheck('model.default', '默认模型', () => checkModel(model)),
+    runCheck('plugin.gate', '拦截门', () => checkGate(state.gateEnabled)),
+    runCheck('plugin.locale', '界面语言', () => checkLocale(readLocale(ctx))),
+    runCheck('market.index', '市场索引', () => checkMarket(readMarketIndexes(ctx))),
+  ])
+  const summary = { ok: 0, warn: 0, fail: 0, unknown: 0 }
+  for (const check of checks) summary[check.status] += 1
+  return { generatedAt: new Date().toISOString(), pluginVersion: manifest.version, dshVersion, summary, checks }
+}
+
+async function aboutText(ctx, state) {
+  const manifest = await readOwnManifest()
+  const dshVersion = await readDshVersion(ctx)
+  return 'dsh-plugin-showcase ' + manifest.version
+    + ' · 工具 ' + TOOL_NAME + '、' + DOCTOR_TOOL_NAME
+    + ' · 命令 /' + COMMAND_NAME + ' on|off|doctor|about'
+    + ' · 拦截门' + (state.gateEnabled ? '已开启' : '已关闭')
+    + ' · DSH ' + (dshVersion === null ? UNKNOWN : dshVersion)
+}
+
 function collectCommandText(exec) {
   const args = exec !== null && typeof exec === 'object' ? exec.arguments : null
   if (args === null || typeof args !== 'object') return ''
@@ -278,8 +586,10 @@ async function runCommand(ctx, state, invocation) {
     state.gateEnabled = false
     return { kind: 'success', text: 'showcase 拦截门: 已关闭' }
   }
-  if (raw !== '') return { kind: 'success', text: USAGE }
   const agent = invocation !== null && typeof invocation === 'object' ? invocation.agent ?? null : null
+  if (raw === 'doctor') return { kind: 'success', text: renderHealth(await buildHealthReport(ctx, state, agent)) }
+  if (raw === 'about') return { kind: 'success', text: await aboutText(ctx, state) }
+  if (raw !== '') return { kind: 'success', text: USAGE }
   return { kind: 'success', text: renderSnapshot(await buildSnapshot(ctx, state, agent)) }
 }
 
@@ -306,7 +616,27 @@ export function apply(ctx) {
     },
   }
 
+  const doctorTool = {
+    name: DOCTOR_TOOL_NAME,
+    description: 'Run the DSH health check and return one report: engine version, working directory, default model, gate state, UI language, and market index sources.',
+    parameters: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {},
+      required: [],
+    },
+    output: {
+      schema: buildHealthSchema(),
+      render: (_args, value) => [{ type: 'text', text: renderHealth(value) }],
+    },
+    async execute(_args, exec) {
+      const agent = exec !== null && typeof exec === 'object' ? exec.agent ?? null : null
+      return await buildHealthReport(ctx, state, agent)
+    },
+  }
+
   ctx.effect(() => ctx.tools.register(inspectTool), 'showcase: inspect tool')
+  ctx.effect(() => ctx.tools.register(doctorTool), 'showcase: doctor tool')
 
   ctx.effect(() => ctx.on('tools/pre-execute', async (exec, next) => {
     let decision = null
@@ -321,8 +651,8 @@ export function apply(ctx) {
 
   ctx.effect(() => ctx.commands.register({
     name: COMMAND_NAME,
-    description: 'Inspect this DSH host. Usage: /showcase [on|off]',
-    input: { hint: '[on|off]' },
+    description: 'Inspect this DSH host. Usage: /showcase [on|off|doctor|about]',
+    input: { hint: '[on|off|doctor|about]' },
     handler: invocation => runCommand(ctx, state, invocation),
   }), 'showcase: /showcase command')
 

package/market/index.json

@@ -0,0 +1,53 @@
+{
+  "format": 1,
+  "title": {
+    "en": "dsh-plugin-showcase",
+    "zh": "功能展示"
+  },
+  "description": {
+    "en": "Self-hosted index shipped inside the dsh-plugin-showcase package.",
+    "zh": "随 dsh-plugin-showcase 包一起分发的自托管索引。"
+  },
+  "metadata": {
+    "categories": {},
+    "labels": {},
+    "sortKeys": {}
+  },
+  "plugins": [
+    {
+      "name": "dsh-plugin-showcase",
+      "title": {
+        "en": "Showcase",
+        "zh": "功能展示"
+      },
+      "description": {
+        "en": "DeepSeek Harness reference plugin: tools, hooks, commands, a settings card and a sidebar panel.",
+        "zh": "DeepSeek Harness 参考插件：工具、钩子、命令、设置卡片与侧栏面板。"
+      },
+      "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2NCA2NCIgd2lkdGg9IjY0IiBoZWlnaHQ9IjY0Ij4KICA8cmVjdCB4PSI0IiB5PSI0IiB3aWR0aD0iNTYiIGhlaWdodD0iNTYiIHJ4PSIxNCIgZmlsbD0iIzJmNmZlZCIvPgogIDxjaXJjbGUgY3g9IjMyIiBjeT0iMzIiIHI9IjE1IiBmaWxsPSJub25lIiBzdHJva2U9IiNmZmYiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLWRhc2hhcnJheT0iNyA1Ii8+CiAgPHRleHQgeD0iMzIiIHk9IjQxIiBmb250LWZhbWlseT0ic2Fucy1zZXJpZiIgZm9udC1zaXplPSIyMiIgZm9udC13ZWlnaHQ9IjcwMCIgZmlsbD0iI2ZmZiIgdGV4dC1hbmNob3I9Im1pZGRsZSI+UzwvdGV4dD4KPC9zdmc+Cg==",
+      "author": "antonioxue",
+      "metadata": {
+        "keywords": [
+          "deepseek-harness",
+          "dsh-plugin",
+          "showcase",
+          "example"
+        ],
+        "labels": [],
+        "sortKeys": {}
+      },
+      "versions": [
+        {
+          "version": "0.2.0",
+          "publishTimestamp": 1792833123,
+          "source": {
+            "type": "npm"
+          },
+          "engines": {
+            "dsh": ">=0.2.1-rc.2"
+          }
+        }
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "dsh-plugin-showcase",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "scripts": {
     "test": "vitest run"
   },
-  "description": "DeepSeek Harness reference plugin: one tool, one slash command, a settings card and a right-sidebar panel.",
+  "description": "DeepSeek Harness starter companion: a health-check tool, a destructive-command gate, a slash command, a settings card and a right-sidebar guide — plus a self-hosted market index.",
   "icon": "./icon.svg",
   "main": "./lib/index.js",
   "exports": {
@@ -25,7 +25,8 @@
     "icon.svg",
     "README.md",
     "README.zh.md",
-    "LICENSE"
+    "LICENSE",
+    "market"
   ],
   "dsh": {
     "manifestVersion": 1,